From de5ee0fbeb70bd4c9bd524da974ccb72ce3e76d8 Mon Sep 17 00:00:00 2001 From: Marcelo Lotif Date: Thu, 22 Feb 2024 12:21:38 -0500 Subject: [PATCH] Updating documentation templates --- .pre-commit-config.yaml | 2 +- docs/source/api.rst | 2 +- docs/source/conf.py | 8 ++++---- docs/source/index.md | 6 ++++-- docs/source/reference/api/aieng_template.rst | 13 ------------- ...ng_template.bar.rst => florist_template.bar.rst} | 4 ++-- ...ng_template.foo.rst => florist_template.foo.rst} | 4 ++-- docs/source/reference/api/florist_template.rst | 13 +++++++++++++ docs/source/user_guide.md | 12 +++++++----- pyproject.toml | 2 +- 10 files changed, 35 insertions(+), 31 deletions(-) delete mode 100644 docs/source/reference/api/aieng_template.rst rename docs/source/reference/api/{aieng_template.bar.rst => florist_template.bar.rst} (55%) rename docs/source/reference/api/{aieng_template.foo.rst => florist_template.foo.rst} (55%) create mode 100644 docs/source/reference/api/florist_template.rst diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d282bde..b6e02ef 100644 --- 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 index c40752c..2272856 100644 --- 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 index d2d87c8..9fc8aa3 100644 --- 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": """ diff --git a/docs/source/index.md b/docs/source/index.md index 710a396..65e0c55 100644 --- 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 deleted file mode 100644 index 5c542d7..0000000 --- a/docs/source/reference/api/aieng_template.rst +++ /dev/null @@ -1,13 +0,0 @@ -aieng\_template namespace -========================= - -.. py:module:: aieng_template - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - aieng_template.bar - aieng_template.foo diff --git a/docs/source/reference/api/aieng_template.bar.rst b/docs/source/reference/api/florist_template.bar.rst similarity index 55% rename from docs/source/reference/api/aieng_template.bar.rst rename to docs/source/reference/api/florist_template.bar.rst index 9abc4b1..2bc3524 100644 --- a/docs/source/reference/api/aieng_template.bar.rst +++ b/docs/source/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/docs/source/reference/api/aieng_template.foo.rst b/docs/source/reference/api/florist_template.foo.rst similarity index 55% rename from docs/source/reference/api/aieng_template.foo.rst rename to docs/source/reference/api/florist_template.foo.rst index eab7d2c..c07030c 100644 --- a/docs/source/reference/api/aieng_template.foo.rst +++ b/docs/source/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 new file mode 100644 index 0000000..7054762 --- /dev/null +++ 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 index 51f882b..bcee30e 100644 --- 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 index 7611d09..90e82a5 100644 --- 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]