From 2081d3cb1bb786a4efae8856e03d04f8f8adf977 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Tue, 7 Jan 2020 16:28:17 -0500 Subject: [PATCH] Rename "Contributing" to Design and development Note that the double anchor label is designed so that we don't break links that might have used the "-contributing" anchor. --- project_templates/stack_package/CHANGELOG.md | 8 ++++++++ .../stack_package/example/doc/lsst.example/index.rst | 8 ++++++-- project_templates/stack_package/example_dds/doc/index.rst | 8 ++++++-- .../doc/lsst.example.pythononly/index.rst | 8 ++++++-- .../stack_package/example_standalone/doc/index.rst | 8 ++++++-- .../doc/lsst.example.subpackage/index.rst | 8 ++++++-- .../doc/{{cookiecutter.python_module}}/index.rst | 8 ++++++-- 7 files changed, 44 insertions(+), 12 deletions(-) diff --git a/project_templates/stack_package/CHANGELOG.md b/project_templates/stack_package/CHANGELOG.md index 1f1885e6..d133bb46 100644 --- a/project_templates/stack_package/CHANGELOG.md +++ b/project_templates/stack_package/CHANGELOG.md @@ -1,5 +1,13 @@ # Change log +## 2020-01-07 + +- Rename the "Contributing" section of the module homepage to "Design and development." + This section can be used more broadly to contain documentation oriented to internal developers. + Pages linked from this section should be contained in a subdirectory named `dev`. + +[DM-21228](https://jira.lsstcorp.org/browse/DM-21228) + ## 2020-01-06 - Add a "Pipeline tasks" section to the module homepage template. diff --git a/project_templates/stack_package/example/doc/lsst.example/index.rst b/project_templates/stack_package/example/doc/lsst.example/index.rst index 89cd950a..b8c53329 100644 --- a/project_templates/stack_package/example/doc/lsst.example/index.rst +++ b/project_templates/stack_package/example/doc/lsst.example/index.rst @@ -19,17 +19,21 @@ lsst.example .. :maxdepth: 1 .. _lsst.example-contributing: +.. _lsst.example-dev: -Contributing -============ +Design and development +====================== ``lsst.example`` is developed at https://github.com/lsst/example. You can find Jira issues for this module under the `example `_ component. .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here. +.. All design and development pages must be maintained in a "dev" subdirectory. .. .. toctree:: .. :maxdepth: 1 +.. +.. dev/page .. _lsst.example-command-line-taskref: diff --git a/project_templates/stack_package/example_dds/doc/index.rst b/project_templates/stack_package/example_dds/doc/index.rst index 93a884f7..1792119f 100644 --- a/project_templates/stack_package/example_dds/doc/index.rst +++ b/project_templates/stack_package/example_dds/doc/index.rst @@ -19,17 +19,21 @@ lsst.example.dds .. :maxdepth: 1 .. _lsst.example.dds-contributing: +.. _lsst.example.dds-dev: -Contributing -============ +Design and development +====================== ``lsst.example.dds`` is developed at https://github.com/lsst/example_dds. You can find Jira issues for this module under the `example_dds `_ component. .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here. +.. All design and development pages must be maintained in a "dev" subdirectory. .. .. toctree:: .. :maxdepth: 1 +.. +.. dev/page .. _lsst.example.dds-command-line-taskref: diff --git a/project_templates/stack_package/example_pythononly/doc/lsst.example.pythononly/index.rst b/project_templates/stack_package/example_pythononly/doc/lsst.example.pythononly/index.rst index 572e4d80..42eb630d 100644 --- a/project_templates/stack_package/example_pythononly/doc/lsst.example.pythononly/index.rst +++ b/project_templates/stack_package/example_pythononly/doc/lsst.example.pythononly/index.rst @@ -19,17 +19,21 @@ lsst.example.pythononly .. :maxdepth: 1 .. _lsst.example.pythononly-contributing: +.. _lsst.example.pythononly-dev: -Contributing -============ +Design and development +====================== ``lsst.example.pythononly`` is developed at https://github.com/lsst/example_pythononly. You can find Jira issues for this module under the `example_pythononly `_ component. .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here. +.. All design and development pages must be maintained in a "dev" subdirectory. .. .. toctree:: .. :maxdepth: 1 +.. +.. dev/page .. _lsst.example.pythononly-command-line-taskref: diff --git a/project_templates/stack_package/example_standalone/doc/index.rst b/project_templates/stack_package/example_standalone/doc/index.rst index e4cb10ea..6da07fb2 100644 --- a/project_templates/stack_package/example_standalone/doc/index.rst +++ b/project_templates/stack_package/example_standalone/doc/index.rst @@ -19,17 +19,21 @@ lsst.example.standalone .. :maxdepth: 1 .. _lsst.example.standalone-contributing: +.. _lsst.example.standalone-dev: -Contributing -============ +Design and development +====================== ``lsst.example.standalone`` is developed at https://github.com/lsst/example_standalone. You can find Jira issues for this module under the `example_standalone `_ component. .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here. +.. All design and development pages must be maintained in a "dev" subdirectory. .. .. toctree:: .. :maxdepth: 1 +.. +.. dev/page .. _lsst.example.standalone-command-line-taskref: diff --git a/project_templates/stack_package/example_subpackage/doc/lsst.example.subpackage/index.rst b/project_templates/stack_package/example_subpackage/doc/lsst.example.subpackage/index.rst index 15d2040a..4265a517 100644 --- a/project_templates/stack_package/example_subpackage/doc/lsst.example.subpackage/index.rst +++ b/project_templates/stack_package/example_subpackage/doc/lsst.example.subpackage/index.rst @@ -19,17 +19,21 @@ lsst.example.subpackage .. :maxdepth: 1 .. _lsst.example.subpackage-contributing: +.. _lsst.example.subpackage-dev: -Contributing -============ +Design and development +====================== ``lsst.example.subpackage`` is developed at https://github.com/lsst/example_subpackage. You can find Jira issues for this module under the `example_subpackage `_ component. .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here. +.. All design and development pages must be maintained in a "dev" subdirectory. .. .. toctree:: .. :maxdepth: 1 +.. +.. dev/page .. _lsst.example.subpackage-command-line-taskref: diff --git a/project_templates/stack_package/{{cookiecutter.package_name}}/doc/{{cookiecutter.python_module}}/index.rst b/project_templates/stack_package/{{cookiecutter.package_name}}/doc/{{cookiecutter.python_module}}/index.rst index c5d6ef35..1f9d0787 100644 --- a/project_templates/stack_package/{{cookiecutter.package_name}}/doc/{{cookiecutter.python_module}}/index.rst +++ b/project_templates/stack_package/{{cookiecutter.package_name}}/doc/{{cookiecutter.python_module}}/index.rst @@ -19,17 +19,21 @@ .. :maxdepth: 1 .. _{{ cookiecutter.python_module }}-contributing: +.. _{{ cookiecutter.python_module }}-dev: -Contributing -============ +Design and development +====================== ``{{ cookiecutter.python_module }}`` is developed at https://github.com/{{ cookiecutter.github_org }}/{{ cookiecutter.package_name }}. You can find Jira issues for this module under the `{{ cookiecutter.package_name }} `_ component. .. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here. +.. All design and development pages must be maintained in a "dev" subdirectory. .. .. toctree:: .. :maxdepth: 1 +.. +.. dev/page {%- if cookiecutter.has_tasks == "True" %} .. _{{ cookiecutter.python_module }}-command-line-taskref: