Skip to content

Commit

Permalink
Made links in the README less confusing
Browse files Browse the repository at this point in the history
  • Loading branch information
AWhetter committed Feb 19, 2024
1 parent 823c146 commit 422004e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ In contrast to the traditional `Sphinx autodoc <https://www.sphinx-doc.org/en/ma
which requires manual authoring and uses code imports,
AutoAPI finds and generates documentation by parsing source code.

For more information, see `the full documentation <https://sphinx-autoapi.readthedocs.org>`_.

Getting Started
---------------

The following steps will walk through how to add AutoAPI to an existing Sphinx project.
For instructions on how to set up a Sphinx project,
see Sphinx's documentation on
`Getting Started <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
see `Sphinx's documentation <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.

Installation
~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions docs/changes/+59dd3b40.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Made links to the documention in the README less confusing.

0 comments on commit 422004e

Please sign in to comment.