diff --git a/doc/README.md b/doc/README.md index 0badd8afe8..4d7dd05353 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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). 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 -on unix you can do with: +[sphinx ReadTheDocs theme](the https://pypi.python.org/pypi/sphinx_rtd_theme). +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 ``` 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` -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: diff --git a/doc/source/bugs.rst b/doc/source/bugs.rst index 240cfd4959..bd58a8f171 100644 --- a/doc/source/bugs.rst +++ b/doc/source/bugs.rst @@ -14,8 +14,8 @@ .. See the License for the specific language governing permissions and .. 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 ` and the ``#cassandra`` :ref:`IRC channel `.