natas_hw
/
cassandra
mirror of https://github.com/apache/cassandra
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: minor title and doc/README.md changes 

Change title to just "Reporting Bugs"
Add sphinx instructions for Python 3.6 on Windows

Closes #202
This commit is contained in:
kbrotman 2018-03-02 16:28:30 +00:00 committed by Stefan Podkowinski
parent 9ed5fc0739
commit a7a36e703c
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/README.md
View File

@ -20,15 +20,16 @@ the `source` subdirectory. The documentation uses [sphinx](http://www.sphinx-doc
and is thus written in [reStructuredText](http://docutils.sourceforge.net/rst.html). and is thus written in [reStructuredText](http://docutils.sourceforge.net/rst.html).
To build the HTML documentation, you will need to first install sphinx and the To build the HTML documentation, you will need to first install sphinx and the
[sphinx ReadTheDocs theme](the https://pypi.python.org/pypi/sphinx_rtd_theme), which [sphinx ReadTheDocs theme](the https://pypi.python.org/pypi/sphinx_rtd_theme).
on unix you can do with: When using Python 3.6 on Windows, use `py -m pip install sphinx sphinx_rtd_theme`, on unix
use:
``` ```
pip install sphinx sphinx_rtd_theme pip install sphinx sphinx_rtd_theme
``` ```
The documentation can then be built from this directory by calling `make html` The documentation can then be built from this directory by calling `make html`
(or `make.bat html` on windows). Alternatively, the top-level `ant gen-doc` (or `make.bat html` on windows). Alternatively, the top-level `ant gen-doc`
target can be used. target can be used. When using Python 3.6 on Windows, use `sphinx_build -b html source build`.
To build the documentation with Docker Compose, run: To build the documentation with Docker Compose, run:

4
doc/source/bugs.rst
View File

@ -14,8 +14,8 @@
.. See the License for the specific language governing permissions and .. See the License for the specific language governing permissions and
.. limitations under the License. .. limitations under the License.
Reporting Bugs and Contributing Reporting Bugs
=============================== ==============
If you encounter a problem with Cassandra, the first places to ask for help are the :ref:`user mailing list If you encounter a problem with Cassandra, the first places to ask for help are the :ref:`user mailing list
<mailing-lists>` and the ``#cassandra`` :ref:`IRC channel <irc-channels>`. <mailing-lists>` and the ``#cassandra`` :ref:`IRC channel <irc-channels>`.