Updating documentation templates

VectorInstitute · Feb 22, 2024 · de5ee0f · de5ee0f
1 parent a1c4d32
commit de5ee0f
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 31 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,5 +44,5 @@ repos:
     - id: doctest
       name: doctest
       entry: python3 -m doctest -o NORMALIZE_WHITESPACE
-      files: "^aieng_template/"
+      files: "^florist/"
       language: system
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -5,4 +5,4 @@ API Reference
    :maxdepth: 1
    :glob:
 
-   reference/api/aieng_template.rst
+   reference/api/florist_template.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,12 +15,12 @@
 from typing import List
 
 
-sys.path.insert(0, os.path.abspath("../../aieng_template"))
+sys.path.insert(0, os.path.abspath("../../florist_template"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = "aieng-template"
+project = "florist"
 copyright = "2024, Vector AI Engineering"  # noqa: A001
 author = "Vector AI Engineering"
 
@@ -56,7 +56,7 @@
 copybutton_prompt_text = r">>> |\.\.\. "
 copybutton_prompt_is_regexp = True
 
-apidoc_module_dir = "../../aieng_template"
+apidoc_module_dir = "../../florist_template"
 apidoc_excluded_paths = ["tests"]
 apidoc_output_dir = "reference/api"
 apidoc_separate_modules = True
@@ -100,7 +100,7 @@
     "footer_icons": [
         {
             "name": "GitHub",
-            "url": "https://github.com/VectorInstitute/aieng-template",
+            "url": "https://github.com/VectorInstitute/FLorist",
             "html": """
                 <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
                     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -2,7 +2,7 @@
 hide-toc: true
 ---
 
-# Vector AI Engineering template repository
+# FLorist
 
 ```{toctree}
 :hidden:
@@ -12,6 +12,8 @@ api
 
 ```
 
+# TODO: modify this when working on updating documentation
+
 This template repository can be used to bootstrap AI Engineering project repositories
 on Github! The template is meant for python codebases since Python is the most commonly
 used language by our team.
@@ -58,7 +60,7 @@ app as an [integration to your repository](https://docs.codecov.com/docs/how-to-
 
 
 If you are starting a new project, you can navigate to the [Use this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) button
-on the top right corner of the [template repository home page](https://github.com/VectorInstitute/aieng-template)
+on the top right corner of the [template repository home page](https://github.com/VectorInstitute/FLorist)
 which will allow you to bootstrap your project repo using this template.
 
 Please check out the user guide page for more detailed information on using the

diff --git a/docs/source/reference/api/aieng_template.rst b/docs/source/reference/api/aieng_template.rst
diff --git a/...urce/reference/api/aieng_template.bar.rst → ...ce/reference/api/florist_template.bar.rst b/...urce/reference/api/aieng_template.bar.rst → ...ce/reference/api/florist_template.bar.rst
@@ -1,7 +1,7 @@
-aieng\_template.bar module
+florist\_template.bar module
 ==========================
 
-.. automodule:: aieng_template.bar
+.. automodule:: florist_template.bar
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/...urce/reference/api/aieng_template.foo.rst → ...ce/reference/api/florist_template.foo.rst b/...urce/reference/api/aieng_template.foo.rst → ...ce/reference/api/florist_template.foo.rst
@@ -1,7 +1,7 @@
-aieng\_template.foo module
+florist\_template.foo module
 ==========================
 
-.. automodule:: aieng_template.foo
+.. automodule:: florist_template.foo
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/reference/api/florist_template.rst b/docs/source/reference/api/florist_template.rst
@@ -0,0 +1,13 @@
+florist\_template namespace
+=========================
+
+.. py:module:: florist_template
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   florist_template.bar
+   florist_template.foo
diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md
@@ -2,6 +2,8 @@
 
 # User Guide
 
+# TODO: modify this when working on updating documentation
+
 ## pyproject.toml file and dependency management
 
 If your project doesn't have a pyproject.toml file, simply copy the one from the
@@ -47,14 +49,14 @@ can add to your repository.
 
 The available workflows are:
 
-- [code checks](https://github.com/VectorInstitute/aieng-template/blob/main/.github/workflows/code_checks.yml): Static code analysis, code formatting and unit tests
-- [documentation](https://github.com/VectorInstitute/aieng-template/blob/main/.github/workflows/docs_deploy.yml): Project documentation including example API reference
-- [integration tests](https://github.com/VectorInstitute/aieng-template/blob/main/.github/workflows/integration_tests.yml): Integration tests
-- [publish](https://github.com/VectorInstitute/aieng-template/blob/main/.github/workflows/publish.yml):
+- [code checks](https://github.com/VectorInstitute/FLorist/blob/main/.github/workflows/code_checks.yml): Static code analysis, code formatting and unit tests
+- [documentation](https://github.com/VectorInstitute/FLorist/blob/main/.github/workflows/docs_deploy.yml): Project documentation including example API reference
+- [integration tests](https://github.com/VectorInstitute/FLorist/blob/main/.github/workflows/integration_tests.yml): Integration tests
+- [publish](https://github.com/VectorInstitute/FLorist/blob/main/.github/workflows/publish.yml):
 Publishing python package to PyPI. Create a `PYPI_API_TOKEN` and add it to the
 repository's actions [secret variables](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
 in order to publish PyPI packages when new software releases are created on Github.
 
 The test workflows also compute coverage and upload code coverage metrics to
-[codecov.io](https://app.codecov.io/gh/VectorInstitute/aieng-template). Create a
+[codecov.io](https://app.codecov.io/gh/VectorInstitute/FLorist). Create a
 `CODECOV_TOKEN` and add it to the repository's actions [secret variables](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions).
diff --git a/pyproject.toml b/pyproject.toml
@@ -138,7 +138,7 @@ markers = [
 
 [tool.coverage]
     [tool.coverage.run]
-    source=["aieng_template"]
+    source=["florist"]
     omit=["tests/*", "*__init__.py"]
 
 [build-system]