Skip to content

Commit

Permalink
Merge pull request astropy#15602 from pllim/fwdport-of-pr-15596-on-main
Browse files Browse the repository at this point in the history
Forwardport PR 15596 onto main (DOC: Fix dev docs in release branch (v6.0.x) TRY 2)
  • Loading branch information
pllim authored Nov 10, 2023
2 parents b2149fa + a3419be commit 83fcda4
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@
# Only include dev docs in dev version.
dev = "dev" in release
if not dev:
exclude_patterns += ["development/*", "testhelpers.rst"]
exclude_patterns += ["development/*"]

# -- Options for the module index ---------------------------------------------

Expand Down Expand Up @@ -377,7 +377,7 @@ def rstjinja(app, docname, source):
# Make sure we're outputting HTML
if app.builder.format != "html":
return
files_to_render = ["index", "install", "development/index"]
files_to_render = ["index_dev", "install"]
if docname in files_to_render:
print(f"Jinja rendering {docname}")
rendered = app.builder.templates.render_string(
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ processing, and data analysis.

index_getting_started
index_user_docs
development/index
index_dev
index_project_details

.. grid:: 2
Expand Down Expand Up @@ -90,7 +90,7 @@ processing, and data analysis.

+++

.. button-ref:: development/index
.. button-ref:: index_dev
:expand:
:color: primary
:click-parent:
Expand Down
30 changes: 15 additions & 15 deletions docs/development/index.rst → docs/index_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@ as well as coding, documentation, and testing guidelines.
{% if is_development %}

For the guiding vision of this process and the project
as a whole, see :doc:`vision`.
as a whole, see :doc:`development/vision`.

.. toctree::
:maxdepth: 1

workflow/development_workflow
workflow/virtual_pythons
workflow/get_devel_version
codeguide
docguide
style-guide
testguide
testhelpers
scripts
building
ccython
releasing
workflow/maintainer_workflow
astropy-package-template
development/workflow/development_workflow
development/workflow/virtual_pythons
development/workflow/get_devel_version
development/codeguide
development/docguide
development/style-guide
development/testguide
development/testhelpers
development/scripts
development/building
development/ccython
development/releasing
development/workflow/maintainer_workflow
development/astropy-package-template

There are some additional tools, mostly of use for maintainers, in the
`astropy/astropy-tools repository
Expand Down

0 comments on commit 83fcda4

Please sign in to comment.