-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adjust: readme
- Loading branch information
Showing
4 changed files
with
46 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,46 @@ | ||
README | ||
====== | ||
|
||
.. APIDOCS command: sphinx-apidoc -o docs/apidocs -eMTf src | ||
.. include:: ../README.md | ||
:parser: myst_parser.sphinx_ | ||
|
||
How to build docs | ||
================= | ||
|
||
#. This documentation is made with `Sphinx <https://www.sphinx-doc.org/>`_, be sure to install it's dependencies: | ||
|
||
.. code:: sh | ||
pip install -r docs/requirements.txt | ||
Ignore this step if requirements already installed. | ||
|
||
#. (*Optional*) Re-generate API-Docs, if source tree changed: | ||
|
||
.. code:: sh | ||
sphinx-apidoc -o docs/apidocs -eMTf src | ||
#. Build HTML documentation: | ||
|
||
.. code:: sh | ||
docs/make html | ||
The built static web site is output to ``docs/_build/html``, we can serve it: | ||
|
||
.. code:: sh | ||
python -m http.server -d docs/_build/html | ||
then open http://localhost:8000/ in a web browser. | ||
|
||
.. tip:: | ||
Try another port if ``8000`` is already in use. | ||
For example, to serve on port ``8080``: | ||
|
||
.. code:: sh | ||
python -m http.server -d docs/_build/html 8080 | ||
.. seealso:: Python ``stdlib``'s :mod:`http.server` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters