-
Notifications
You must be signed in to change notification settings - Fork 785
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1345 from willingc/remove-doc-tutorial
Remove the Creating Documentation tutorial
- Loading branch information
Showing
2 changed files
with
4 additions
and
64 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,66 +1,7 @@ | ||
.. _creating-documentation: | ||
:orphan: | ||
|
||
Creating documentation | ||
====================== | ||
Creating Documentation | ||
====================== | ||
|
||
This section covers the basics of how to create documentation using `Sphinx`_ and | ||
host the documentation for free in `Read The Docs`_. | ||
|
||
.. _Sphinx: https://www.sphinx-doc.org | ||
.. _Read The Docs: https://readthedocs.org/ | ||
|
||
Installing Sphinx | ||
----------------- | ||
Use ``pip`` to install Sphinx: | ||
|
||
.. tab:: Unix/macOS | ||
|
||
.. code-block:: bash | ||
python3 -m pip install --upgrade sphinx | ||
.. tab:: Windows | ||
|
||
.. code-block:: bat | ||
py -m pip install --upgrade sphinx | ||
For other installation methods, see this :doc:`installation guide <sphinx:usage/installation>` by Sphinx. | ||
|
||
|
||
Getting Started With Sphinx | ||
--------------------------- | ||
|
||
Create a ``docs`` directory inside your project to hold your documentation: | ||
|
||
.. code-block:: bash | ||
cd /path/to/project | ||
mkdir docs | ||
Run ``sphinx-quickstart`` inside the ``docs`` directory: | ||
|
||
.. code-block:: bash | ||
cd docs | ||
sphinx-quickstart | ||
This sets up a source directory, walks you through some basic configurations, and creates an ``index.rst`` file as well as a ``conf.py`` file. | ||
|
||
You can add some information about your project in ``index.rst``, then build them: | ||
|
||
.. code-block:: bash | ||
make html | ||
For more details on the build process, see this `guide`_ by Read The Docs. | ||
|
||
.. _guide: https://docs.readthedocs.io/en/latest/intro/import-guide.html | ||
|
||
Other Sources | ||
------------- | ||
|
||
For a more detailed guide on how to use Sphinx and reStructuredText, please see this `documentation tutorial`_ on Hitchhiker's Guide to Python. | ||
|
||
.. _documentation tutorial: https://docs.python-guide.org/writing/documentation/ | ||
This tutorial has been removed since it is not related to packaging and was unmaintained. | ||
Please see the `Sphinx tutorial <https://www.sphinx-doc.org/en/master/tutorial>`_ instead. |
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