From d45455d6f2b622dec1e507065043841007b6b23d Mon Sep 17 00:00:00 2001 From: Tom Aldcroft Date: Tue, 11 Jun 2024 14:36:31 -0400 Subject: [PATCH] Bring the pandas files into the main dev dir --- docs/conf.py | 2 +- docs/development/{pd => }/community.rst | 0 docs/development/{pd => }/contributing.rst | 0 .../{pd => }/contributing_codebase.rst | 0 .../{pd => }/contributing_docstring.rst | 0 .../{pd => }/contributing_documentation.rst | 0 .../{pd => }/contributing_environment.rst | 0 .../{pd => }/contributing_gitpod.rst | 0 docs/development/{pd => }/copy_on_write.rst | 0 .../{pd => }/debugging_extensions.rst | 0 docs/development/{pd => }/developer.rst | 0 docs/development/{pd => }/extending.rst | 0 docs/development/index.rst | 77 +++++++++++++++++++ docs/development/{pd => }/internals.rst | 0 docs/development/{pd => }/maintaining.rst | 0 docs/development/pd/index.rst | 24 ------ docs/development/{pd => }/policies.rst | 0 docs/index.rst | 4 +- docs/index_dev.rst | 71 ----------------- 19 files changed, 80 insertions(+), 98 deletions(-) rename docs/development/{pd => }/community.rst (100%) rename docs/development/{pd => }/contributing.rst (100%) rename docs/development/{pd => }/contributing_codebase.rst (100%) rename docs/development/{pd => }/contributing_docstring.rst (100%) rename docs/development/{pd => }/contributing_documentation.rst (100%) rename docs/development/{pd => }/contributing_environment.rst (100%) rename docs/development/{pd => }/contributing_gitpod.rst (100%) rename docs/development/{pd => }/copy_on_write.rst (100%) rename docs/development/{pd => }/debugging_extensions.rst (100%) rename docs/development/{pd => }/developer.rst (100%) rename docs/development/{pd => }/extending.rst (100%) create mode 100644 docs/development/index.rst rename docs/development/{pd => }/internals.rst (100%) rename docs/development/{pd => }/maintaining.rst (100%) delete mode 100644 docs/development/pd/index.rst rename docs/development/{pd => }/policies.rst (100%) delete mode 100644 docs/index_dev.rst diff --git a/docs/conf.py b/docs/conf.py index 4af834c564ac..8f83f9182d98 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -376,7 +376,7 @@ def rstjinja(app, docname, source): # Make sure we're outputting HTML if app.builder.format != "html": return - files_to_render = ["index_dev", "install"] + files_to_render = ["development/index", "install"] if docname in files_to_render: logger.info("Jinja rendering %s", docname) rendered = app.builder.templates.render_string( diff --git a/docs/development/pd/community.rst b/docs/development/community.rst similarity index 100% rename from docs/development/pd/community.rst rename to docs/development/community.rst diff --git a/docs/development/pd/contributing.rst b/docs/development/contributing.rst similarity index 100% rename from docs/development/pd/contributing.rst rename to docs/development/contributing.rst diff --git a/docs/development/pd/contributing_codebase.rst b/docs/development/contributing_codebase.rst similarity index 100% rename from docs/development/pd/contributing_codebase.rst rename to docs/development/contributing_codebase.rst diff --git a/docs/development/pd/contributing_docstring.rst b/docs/development/contributing_docstring.rst similarity index 100% rename from docs/development/pd/contributing_docstring.rst rename to docs/development/contributing_docstring.rst diff --git a/docs/development/pd/contributing_documentation.rst b/docs/development/contributing_documentation.rst similarity index 100% rename from docs/development/pd/contributing_documentation.rst rename to docs/development/contributing_documentation.rst diff --git a/docs/development/pd/contributing_environment.rst b/docs/development/contributing_environment.rst similarity index 100% rename from docs/development/pd/contributing_environment.rst rename to docs/development/contributing_environment.rst diff --git a/docs/development/pd/contributing_gitpod.rst b/docs/development/contributing_gitpod.rst similarity index 100% rename from docs/development/pd/contributing_gitpod.rst rename to docs/development/contributing_gitpod.rst diff --git a/docs/development/pd/copy_on_write.rst b/docs/development/copy_on_write.rst similarity index 100% rename from docs/development/pd/copy_on_write.rst rename to docs/development/copy_on_write.rst diff --git a/docs/development/pd/debugging_extensions.rst b/docs/development/debugging_extensions.rst similarity index 100% rename from docs/development/pd/debugging_extensions.rst rename to docs/development/debugging_extensions.rst diff --git a/docs/development/pd/developer.rst b/docs/development/developer.rst similarity index 100% rename from docs/development/pd/developer.rst rename to docs/development/developer.rst diff --git a/docs/development/pd/extending.rst b/docs/development/extending.rst similarity index 100% rename from docs/development/pd/extending.rst rename to docs/development/extending.rst diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 000000000000..c9f8d694c7b9 --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,77 @@ +.. _developer-docs: + +*********** +Development +*********** + +The developer documentation contains instructions for how to contribute to +Astropy or affiliated packages, install and test the development version, +as well as coding, documentation, and testing guidelines. + +{% if is_development %} + +Contributing quickstart +----------------------- + +This section provides a quickstart guide to contributing to Astropy. With minor +changes the process will apply to contributing to coordinated and many affiliated +packages. + +.. toctree:: + :maxdepth: 2 + + contributing + contributing_environment + contributing_documentation + contributing_codebase + maintaining + internals + copy_on_write + debugging_extensions + extending + developer + policies + community + +Legacy documentation +-------------------- + +.. toctree:: + :maxdepth: 2 + + workflow/development_workflow + workflow/git_edit_workflow_examples + workflow/virtual_pythons + workflow/get_devel_version + codeguide + docguide + style-guide + testguide + scripts + building + ccython + +Git resources +------------- +.. toctree:: + :maxdepth: 2 + + workflow/git_resources + workflow/additional_git_topics + + +Maintaining astropy and affiliated packages +------------------------------------------- + +.. toctree:: + :maxdepth: 2 + + maintainers/maintainers-index + +{%else%} + +To read the developer documentation, you will need to go to the :ref:`latest +developer version of the documentation +`. + +{%endif%} diff --git a/docs/development/pd/internals.rst b/docs/development/internals.rst similarity index 100% rename from docs/development/pd/internals.rst rename to docs/development/internals.rst diff --git a/docs/development/pd/maintaining.rst b/docs/development/maintaining.rst similarity index 100% rename from docs/development/pd/maintaining.rst rename to docs/development/maintaining.rst diff --git a/docs/development/pd/index.rst b/docs/development/pd/index.rst deleted file mode 100644 index ce4183a601e3..000000000000 --- a/docs/development/pd/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _development: - -=========== -Development -=========== - -.. If you update this toctree, also update the manual toctree in the - main index.rst.template - -.. toctree:: - :maxdepth: 2 - - contributing - contributing_environment - contributing_documentation - contributing_codebase - maintaining - internals - copy_on_write - debugging_extensions - extending - developer - policies - community diff --git a/docs/development/pd/policies.rst b/docs/development/policies.rst similarity index 100% rename from docs/development/pd/policies.rst rename to docs/development/policies.rst diff --git a/docs/index.rst b/docs/index.rst index 5848fd730f89..ff908ab68a7c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,7 @@ processing, and data analysis. index_getting_started index_user_docs - index_dev + development/index index_project_details .. grid:: 2 @@ -90,7 +90,7 @@ processing, and data analysis. +++ - .. button-ref:: index_dev + .. button-ref:: development/index :expand: :color: primary :click-parent: diff --git a/docs/index_dev.rst b/docs/index_dev.rst deleted file mode 100644 index df59298ecf4b..000000000000 --- a/docs/index_dev.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. _developer-docs: - -*********** -Development -*********** - -The developer documentation contains instructions for how to contribute to -Astropy or affiliated packages, install and test the development version, -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:`development/vision`. - -Contributing to astropy ------------------------- - -.. toctree:: - :maxdepth: 2 - -New documentation ------------------ - -.. toctree:: - :maxdepth: 2 - - development/pd/index - -Legacy documentation --------------------- - -.. toctree:: - :maxdepth: 2 - - development/workflow/development_workflow - development/workflow/git_edit_workflow_examples - development/workflow/virtual_pythons - development/workflow/get_devel_version - development/codeguide - development/docguide - development/style-guide - development/testguide - development/scripts - development/building - development/ccython - -Git resources -------------- -.. toctree:: - :maxdepth: 2 - - development/workflow/git_resources - development/workflow/additional_git_topics - - -Maintaining astropy and affiliated packages -------------------------------------------- - -.. toctree:: - :maxdepth: 2 - - development/maintainers/maintainers-index - -{%else%} - -To read the developer documentation, you will need to go to the :ref:`latest -developer version of the documentation -`. - -{%endif%}