Skip to content

Commit 8d708b4

Browse files
pllimpllim
committed
DOC: Remove index page sidebar
because it is repetitive Fix TOC layout Fix reference API TOC Fix pre-commit complains. Use newly released sphinx-astropy.
1 parent d3f8bed commit 8d708b4

49 files changed

Lines changed: 373 additions & 256 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎astropy/cosmology/__init__.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
"""``astropy.cosmology`` contains classes and functions for cosmological
33
distance measures and other cosmology-related calculations.
44
5-
See the `Astropy documentation
6-
<https://docs.astropy.org/en/latest/cosmology/index.html>`_ for more
5+
See the :ref:`astropy-cosmology` for more
76
detailed usage examples and references.
87
98
"""

‎docs/_static/custom.css‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/conf.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,6 @@
231231

232232
# -- Options for HTML output ---------------------------------------------------
233233

234-
html_static_path = ["_static"]
235-
html_css_files = ["custom.css"]
236234
html_logo = "_static/astropy_banner_96.png"
237235
html_theme_options.update(
238236
{

‎docs/config/index.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,10 @@ See Also
507507
Reference/API
508508
=============
509509

510-
.. automodapi:: astropy.config
510+
.. toctree::
511+
:maxdepth: 2
512+
513+
ref_api
511514

512515
.. testcleanup::
513516

‎docs/config/ref_api.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Reference/API
2+
*************
3+
4+
.. automodapi:: astropy.config

‎docs/convolution/index.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,5 +422,7 @@ Using `astropy.convolution`
422422
Reference/API
423423
=============
424424

425-
.. automodapi:: astropy.convolution
426-
:no-inheritance-diagram:
425+
.. toctree::
426+
:maxdepth: 2
427+
428+
ref_api

‎docs/convolution/ref_api.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Reference/API
2+
*************
3+
4+
.. automodapi:: astropy.convolution
5+
:no-inheritance-diagram:

‎docs/coordinates/index.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -550,4 +550,7 @@ Built-in Frames and Transformations
550550
Reference/API
551551
=============
552552

553-
.. automodapi:: astropy.coordinates
553+
.. toctree::
554+
:maxdepth: 2
555+
556+
ref_api

‎docs/coordinates/ref_api.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Reference/API
2+
*************
3+
4+
.. automodapi:: astropy.coordinates

‎docs/cosmology/index.rst‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ listed below.
113113

114114
Reading and Writing <io>
115115
Units and Equivalencies <units>
116-
116+
For Developers <dev>
117117

118118
Most of the functionality is enabled by the |FLRW| object. This represents a
119119
homogeneous and isotropic cosmology (characterized by the
@@ -510,15 +510,7 @@ better than that, despite the fact that five digits are quoted in the papers.
510510
Reference/API
511511
=============
512512

513-
More detailed information on using the package is provided on separate pages,
514-
listed below.
515-
516513
.. toctree::
517-
:maxdepth: 1
518-
519-
Reading and Writing <io>
520-
For Developers <dev>
521-
514+
:maxdepth: 2
522515

523-
.. automodapi:: astropy.cosmology
524-
:inherited-members:
516+
ref_api

0 commit comments

Comments
 (0)