Skip to content

Commit

Permalink
dev docs guide
Browse files Browse the repository at this point in the history
Signed-off-by: Nathaniel Starkman (@nstarman) <nstarkman@protonmail.com>
  • Loading branch information
nstarman committed May 17, 2021
1 parent 61a7b37 commit 979ae64
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/development/docguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,13 @@ the standard Astropy docstring format.

* All documentation should be written using the `Sphinx`_
documentation tool.


+ cross-reference links (``:ref:``, ``:doc:``, etc.), **including internal
Astropy links**, should use the `intersphinx format
<https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_.
Note that in Astropy these internal links are to the current build, while
for affiliate packages these links resolve to the stable version.

* ReST substitutions are centralized in ``docs/conf.py::rst_epilog`` for
consistency across the documentation and docstrings. These should be used over
custom redefinitions; and new substitutions should probably be placed there.
Expand Down

0 comments on commit 979ae64

Please sign in to comment.