Merge pull request #32 from naik-aakash/doc_framework

Doc framework
autoatml · Feb 6, 2024 · b2d16fa · b2d16fa
2 parents a4f2802 + 78788ac
commit b2d16fa
Show file tree

Hide file tree

Showing 81 changed files with 1,818 additions and 12 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -68,3 +68,23 @@ jobs:
           run: |
             coverage combine coverage*/.coverage*
             coverage report --show-missing
+
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[docs,strict]
+
+      - name: Build
+        run: sphinx-build -W docs _build
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Contributions are welcome. Please raise a pull request for contributions first.
 - please ensure high coverage of the code based on the tests
 
 # Commit guidelines
-1. `pip install pre-commit`
+1. `pip install pre-commit`.
 2. Next, run `pre-commit install` (this will install all the hooks from pre-commit-config.yaml)
 3. Step 1 and 2, needs to be done only once in the local repository
 4. Procced with modifying the code and add commits as usual.

diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,70 @@
+/*!* Override some aspects of the pydata-sphinx-theme *!*/
+/*@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap');*/
+
+/*:root {*/
+/*  !* Use softer blue from bootstrap's default info color *!*/
+/*  --pst-color-info: 23, 162, 184;*/
+/*}*/
+
+/*!* Main index page overview cards *!*/
+
+/*.intro-card {*/
+/*  background: #fff;*/
+/*  border-radius: 0;*/
+/*  padding: 30px 10px 20px 10px;*/
+/*  margin: 10px 0px;*/
+/*}*/
+
+/*.intro-card p.card-text {*/
+/*  margin: 0px;*/
+/*}*/
+
+/*.intro-card .card-img-top {*/
+/*  margin: 10px;*/
+/*  height: 52px;*/
+/*}*/
+
+/*.intro-card .card-header {*/
+/*  border: none;*/
+/*  background-color:white;*/
+/*  color: #150458 !important;*/
+/*  font-size: var(--pst-font-size-h5);*/
+/*  font-weight: bold;*/
+/*  padding: 2.5rem 0rem 0.5rem 0rem;*/
+/*}*/
+
+/*.intro-card .card-footer {*/
+/*  border: none;*/
+/*  background-color:white;*/
+/*}*/
+
+/*.intro-card .card-footer p.card-text{*/
+/*  max-width: 220px;*/
+/*  margin-left: auto;*/
+/*  margin-right: auto;*/
+/*}*/
+
+
+/*body {*/
+/*  font-family: 'Open Sans', sans-serif;*/
+/*  color:#4A4A4A; !* numpy.org body color *!*/
+/*}*/
+
+/*pre, code {*/
+/*  !*font-size: 100%;*!*/
+/*  !*line-height: 155%;*!*/
+/*}*/
+
+/*h1 {*/
+/*  font-family: "Lato", sans-serif;*/
+/*}*/
+
+
+/*h2 {*/
+/*  letter-spacing: -.03em;*/
+/*}*/
+
+/*h3 {*/
+/*  !*color: #013243; !* warm black *!*!*/
+/*  letter-spacing: -.03em;*/
+/*}*/
diff --git a/docs/_static/fonts/lato-bold-italic.woff b/docs/_static/fonts/lato-bold-italic.woff
diff --git a/docs/_static/fonts/lato-bold-italic.woff2 b/docs/_static/fonts/lato-bold-italic.woff2
diff --git a/docs/_static/fonts/lato-bold.woff b/docs/_static/fonts/lato-bold.woff
diff --git a/docs/_static/fonts/lato-bold.woff2 b/docs/_static/fonts/lato-bold.woff2
diff --git a/docs/_static/fonts/lato-normal-italic.woff b/docs/_static/fonts/lato-normal-italic.woff
diff --git a/docs/_static/fonts/lato-normal-italic.woff2 b/docs/_static/fonts/lato-normal-italic.woff2
diff --git a/docs/_static/fonts/lato-normal.woff b/docs/_static/fonts/lato-normal.woff
diff --git a/docs/_static/fonts/lato-normal.woff2 b/docs/_static/fonts/lato-normal.woff2
diff --git a/docs/_static/index_api.svg b/docs/_static/index_api.svg
diff --git a/docs/_static/index_contribute.svg b/docs/_static/index_contribute.svg
diff --git a/docs/_static/index_support.svg b/docs/_static/index_support.svg
diff --git a/docs/_static/index_user_guide.svg b/docs/_static/index_user_guide.svg
diff --git a/docs/_static/orcid.svg b/docs/_static/orcid.svg
diff --git a/docs/_templates/autosummary/base.rst b/docs/_templates/autosummary/base.rst
@@ -0,0 +1,5 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -0,0 +1,7 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :show-inheritance:
+   :members:
diff --git a/docs/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst
@@ -0,0 +1,5 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}