Merge pull request #460 from OliviaLynn/main

Documentation Prefactor
lincc-frameworks · Jun 21, 2024 · e154839 · e154839
2 parents 0dd9a5b + 0b9327b
commit e154839
Show file tree

Hide file tree

Showing 17 changed files with 326 additions and 164 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,32 +18,37 @@ please :doc:`/source/contact`
 .. toctree::
    :maxdepth: 1
    :caption: Using the Template
+   :hidden:
 
    source/overview
    source/new_project
+   source/existing_project
    source/configuration_checklist
    source/update_project
-   source/existing_project
    source/contributing
    source/contact
 
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Template Options
+   :hidden:
+
+   source/template_options
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Best Practices
+   :hidden:
 
    practices/overview
-   practices/ci_benchmarking
-   practices/ci_precommit
-   practices/ci_testing
-   practices/code_coverage
-   practices/git-lfs
-   practices/issue_pr_templating
-   practices/linting
-   practices/namespace_project
    practices/pipx
    practices/precommit
-   practices/pypi
-   practices/conda
-   practices/unit_testing
-   practices/pytest_timeout
+   practices/linting
+   practices/ci
+   practices/namespace_project
+   practices/issue_pr_templating
    practices/sphinx
+   practices/publishing_package
+
diff --git a/docs/practices/ci.rst b/docs/practices/ci.rst
@@ -0,0 +1,13 @@
+Continuous Integration
+===============================================================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Continuous Integration
+
+   ci_testing
+   ci_benchmarking
+   ci_precommit
+   code_coverage
+   unit_testing
+   pytest_timeout
diff --git a/docs/practices/git-lfs.rst b/docs/practices/git-lfs.rst
diff --git a/docs/practices/linting.rst b/docs/practices/linting.rst
@@ -1,4 +1,4 @@
-Code Style
+Code Style: Linters, Auto-Formatters
 ===============================================================================
 
 What is it? Why do it?

diff --git a/docs/practices/namespace_project.rst b/docs/practices/namespace_project.rst
@@ -1,5 +1,5 @@
-Python namespace project
-========================
+Python Namespace Projects
+=========================
 
 `Pep 420 <https://peps.python.org/pep-0420/>`_ defines a standard for namespace packages. 
 This standard allows for separately versioned and maintained subpackages to present 

diff --git a/docs/practices/overview.rst b/docs/practices/overview.rst
@@ -19,7 +19,6 @@ Practices
 * :doc:`precommit`
 * :doc:`pypi`
 * :doc:`sphinx`
-* :doc:`git-lfs`
 * :doc:`pytest_timeout`
 
 Still have questions?

diff --git a/docs/practices/pipx.rst b/docs/practices/pipx.rst
@@ -1,5 +1,5 @@
-pipx
-=========
+Pipx
+====================================================================================================
 
 ``pipx`` is a tool to enable installation of end-user applications written 
 in Python.

diff --git a/docs/practices/publishing_package.rst b/docs/practices/publishing_package.rst
@@ -0,0 +1,8 @@
+Publishing Your Package: PyPI, Conda
+===============================================================================
+
+.. toctree::
+   :maxdepth: 1
+
+   pypi
+   conda
diff --git a/docs/practices/pypi.rst b/docs/practices/pypi.rst
@@ -1,4 +1,4 @@
-PyPI
+PyPI Publishing
 ===============================================================================
 
 What is it? Why do it?

diff --git a/docs/practices/sphinx.rst b/docs/practices/sphinx.rst
@@ -1,4 +1,4 @@
-Sphinx - ReadTheDocs and AutoAPI
+Sphinx: ReadTheDocs, AutoAPI
 ===============================================================================
 
 What is it? Why do it?

diff --git a/docs/source/configuration_checklist.rst b/docs/source/configuration_checklist.rst
@@ -1,4 +1,4 @@
-Configuring a new project
+Configure a templated project
 ===============================================================================
 
 So you've created a new python project from the template! Great!

diff --git a/docs/source/contact.rst b/docs/source/contact.rst
@@ -1,4 +1,4 @@
-Contact us
+Any questions? Contact us
 ===============================================================================
 
 We at LINCC Frameworks pride ourselves on being a friendly bunch!

diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -1,4 +1,4 @@
-Contributing to the template
+Contribute to the template
 ===============================================================================
 
 Find (or make) a new GitHub issue

diff --git a/docs/source/existing_project.rst b/docs/source/existing_project.rst
@@ -1,4 +1,4 @@
-Incorporating the template into a prior project
+or, Hydrate an un-templated project
 ===============================================================================
 
 These instructions are for those who want to incorporate the latest version of the 

diff --git a/docs/source/new_project.rst b/docs/source/new_project.rst
@@ -1,4 +1,4 @@
-Starting a new project
+Create a new templated project
 ===============================================================================
 
 
@@ -173,8 +173,3 @@ Next steps
 -------------------------------------------------------------------------------
 
 :doc:`Configure a new project<configuration_checklist>`
-
-Still have questions?
--------------------------------------------------------------------------------
-
-:doc:`/source/contact`