Skip to content

Commit

Permalink
Tweak description of how to build docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
brandon-rhodes committed May 19, 2018
1 parent 0a8f1ac commit 86f8fa4
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,13 @@ features are working correctly on your operating system and platform::

python -m unittest discover ephem

You can build the documentation to see whether the changes done
look as expected. The documentation is written in a `Sphinx
<http://www.sphinx-doc.org/en/master/>`_-conform manner.
In the folder `pyephem/ephem/doc/` several rst-files are provided
which can be built with the default command (see sphinx for more
details):
PyEphem’s documentation is organized as a standard `Sphinx
<http://www.sphinx-doc.org/en/master/>`_ document project. You can
build the documentation either with the Sphinx command line::

sphinx-build -b html pyephem/ephem/doc/ ./my_documentation_directory/

— or, more typically, by invoking one of the targets in the
documentation’s Makefile::

make -C ephem/doc html

1 comment on commit 86f8fa4

@1kastner
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that wording sounds much nicer than mine!

Please sign in to comment.