Merge pull request #119 from RTIInternational/112-add-documentation

112 add documentation

.github/workflows/documentation-publish.yml

@@ -0,0 +1,33 @@
+name: documentation
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+    # branches: [112-add-documentation]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install sphinx pydata-sphinx-theme myst-nb sphinx-design sphinx-autoapi numpydoc ghp-import -e .
+
+      - name: Sphinx build
+        run: |
+          cd docs/sphinx
+          make clean html
+
+      - name: Run ghp-import
+        run: |
+          ghp-import -n -p -f docs/sphinx/_build/html

.gitignore

@@ -69,7 +69,12 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/sphinx/_build/
+docs/sphinx/_autosummary/
+docs/sphinx/_static/*.html
+docs/sphinx/generated/
+docs/sphinx/savefig/
+docs/sphinx/getting_started/test_data/temp_test.db
 
 # PyBuilder
 target/

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  -   id: trailing-whitespace
+  -   id: end-of-file-fixer
+  -   id: check-yaml
+      args: [--allow-multiple-documents]
+  -   id: check-added-large-files
+      args: ['--maxkb=13000', '--enforce-all']
+- repo: https://github.com/numpy/numpydoc
+  rev: v1.6.0
+  hooks:
+    - id: numpydoc-validation

.vscode/settings.json

@@ -3,4 +3,4 @@
         "PYTHONPATH": "${workspaceFolder}/src"
     },
     "files.trimTrailingWhitespace": true,
-}
+}

README.md

@@ -13,11 +13,15 @@ assess their skill and performance.
 
 NOTE: THIS PROJECT IS UNDER DEVELOPMENT - EXPECT TO FIND BROKEN AND INCOMPLETE CODE.
 
+## Documentation
+[TEEHR Documentation](https://rtiinternational.github.io/teehr/)
+
 ## How to Install TEEHR
 Install poetry
 ```bash
 $ pipx install poetry
 ```
+
 Install from source
 ```bash
 # Create and activate python environment, requires python >= 3.10
@@ -38,8 +42,8 @@ $ poetry add git+https://github.com/RTIInternational/teehr.git#[BRANCH TAG]
 
 Use Docker
 ```bash
-$ docker build -t teehr:v0.3.8 .
-$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.3.8 jupyter lab --ip 0.0.0.0 $HOME
+$ docker build -t teehr:v0.3.9 .
+$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.3.9 jupyter lab --ip 0.0.0.0 $HOME
 ```
 
 ## Examples

docs/sphinx/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/sphinx/_static/css/teehr.css

@@ -0,0 +1,70 @@
+/* Override some aspects of the pydata-sphinx-theme */
+
+:root {
+    /* Use softer blue from bootstrap's default info color */
+    --pst-color-info: 23, 162, 184;
+  }
+
+  table {
+    width: auto; /* Override fit-content which breaks Styler user guide ipynb */
+  }
+
+  /* Main index page overview cards */
+
+  .intro-card {
+    padding: 30px 10px 20px 10px;
+  }
+
+  .intro-card .sd-card-img-top {
+    margin: 10px;
+    height: 52px;
+    background: none !important;
+  }
+
+  .intro-card .sd-card-title {
+    color: var(--pst-color-primary);
+    font-size: var(--pst-font-size-h5);
+    padding: 1rem 0rem 0.5rem 0rem;
+  }
+
+  .intro-card .sd-card-footer {
+    border: none !important;
+  }
+
+  .intro-card .sd-card-footer p.sd-card-text {
+    max-width: 220px;
+    margin-left: auto;
+    margin-right: auto;
+  }
+
+  .intro-card .sd-btn-secondary {
+    background-color: #6c757d !important;
+    border-color: #6c757d !important;
+  }
+
+  .intro-card .sd-btn-secondary:hover {
+    background-color: #5a6268 !important;
+    border-color: #545b62 !important;
+  }
+
+  .card, .card img {
+    background-color: var(--pst-color-background);
+  }
+
+  .ciroh-card {
+    margin: 10px;
+    height: 140px;
+    background: none !important;
+  }
+
+  html[data-theme="dark"] {
+    h1 {
+      color: rgb(138, 189, 216);
+    }
+    h2 {
+      color: rgb(138, 189, 216);
+    }
+    h3 {
+      color: rgb(138, 189, 216);
+    }
+}