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 Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/a7a36e70 Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/a7a36e70 Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/a7a36e70 Branch: refs/heads/trunk Commit: a7a36e703c8b4a0a126b2f750e2dbe56440658ea Parents: 9ed5fc0 Author: kbrotman <33668875+kbrot...@users.noreply.github.com> Authored: Fri Mar 2 16:28:30 2018 +0000 Committer: Stefan Podkowinski <stefan.podkowin...@1und1.de> Committed: Tue Mar 6 11:20:51 2018 +0100 ---------------------------------------------------------------------- doc/README.md | 7 ++++--- doc/source/bugs.rst | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cassandra/blob/a7a36e70/doc/README.md ---------------------------------------------------------------------- diff --git a/doc/README.md b/doc/README.md index 0badd8a..4d7dd05 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: http://git-wip-us.apache.org/repos/asf/cassandra/blob/a7a36e70/doc/source/bugs.rst ---------------------------------------------------------------------- diff --git a/doc/source/bugs.rst b/doc/source/bugs.rst index 240cfd4..bd58a8f 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 <mailing-lists>` and the ``#cassandra`` :ref:`IRC channel <irc-channels>`. --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
