From 74e8c785120454b65fc40d29bb6f10b58100d755 Mon Sep 17 00:00:00 2001 From: Tom Aldcroft Date: Tue, 2 Jul 2024 05:31:02 -0400 Subject: [PATCH] Revert move of index_dev.rst to development/index.rst --- docs/conf.py | 2 +- docs/index.rst | 4 ++-- docs/{development/index.rst => index_dev.rst} | 24 +++++++++---------- 3 files changed, 15 insertions(+), 15 deletions(-) rename docs/{development/index.rst => index_dev.rst} (87%) diff --git a/docs/conf.py b/docs/conf.py index a4a5088706f8..31c28e9a0b2c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -375,7 +375,7 @@ def rstjinja(app, docname, source): # Make sure we're outputting HTML if app.builder.format != "html": return - files_to_render = ["development/index", "install"] + files_to_render = ["index_dev", "install"] if docname in files_to_render: logger.info("Jinja rendering %s", docname) rendered = app.builder.templates.render_string( diff --git a/docs/index.rst b/docs/index.rst index 2909e2667cbe..94929d1619ca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,7 @@ processing, and data analysis. index_getting_started index_user_docs - development/index + index_dev index_project_details .. grid:: 2 @@ -93,7 +93,7 @@ processing, and data analysis. +++ - .. button-ref:: development/index + .. button-ref:: index_dev :expand: :color: primary :click-parent: diff --git a/docs/development/index.rst b/docs/index_dev.rst similarity index 87% rename from docs/development/index.rst rename to docs/index_dev.rst index eb38d066f877..bc055c476b38 100644 --- a/docs/development/index.rst +++ b/docs/index_dev.rst @@ -35,7 +35,7 @@ process will apply to contributing updates to coordinated and many affiliated pa .. toctree:: :maxdepth: 2 - quickstart + development/quickstart Now that you have created your development environment and gotten familiar with the process, you should now read through the detailed tutorial below to see a real-life @@ -45,7 +45,7 @@ advice for making a code change. .. toctree:: :maxdepth: 1 - git_edit_workflow_examples + development/git_edit_workflow_examples Congratulations, now you are ready to be an Astropy contributor! If you are not sure where to contribute, take a look at the `Good First Issues `_ @@ -58,15 +58,15 @@ Details .. toctree:: :maxdepth: 1 - development_details - codeguide - testguide - docguide - style-guide - git_resources - scripts - ccython - maintainers/index + development/development_details + development/codeguide + development/testguide + development/docguide + development/style-guide + development/git_resources + development/scripts + development/ccython + development/maintainers/index .. Note:: Parts of this guide were adapted from the `pandas developer documentation `_. Astropy is grateful to the pandas team for their documentation efforts. @@ -74,6 +74,6 @@ Details {%else%} To read the developer documentation, you will need to go to the -`latest developer version of the documentation `_. +`latest developer version of the documentation `_. {%endif%}