Switch to Docusaurus (#182)

* shifted docs to docusaurus

* fixed bug in yaml

* updated pydoc-markdown for python 3.6

.github/pull_request_template.md

@@ -12,7 +12,7 @@ E.g. Describe the added feature or what issue it fixes #(issue)...
   - [ ] Did you run black and isort prior to submitting your PR? 
   - [ ] Does your PR pass all existing unit tests?
   - [ ] Did you add associated unit tests for any additional functionality?
-  - [ ] Did you provide documentation ([Numpy Docstring format](https://numpydoc.readthedocs.io/en/latest/format.html#style-guide)) whenever possible, even for simple functions or classes?
+  - [ ] Did you provide documentation ([Google Docstring format](https://google.github.io/styleguide/pyguide.html)) whenever possible, even for simple functions or classes?
 
 ## Review
 Request will go to reviewers to approve for merge.

.github/workflows/python-test-docs.yaml

@@ -0,0 +1,44 @@
+# This workflow will verify that documentation can still build successfully
+
+name: docs-test-build
+
+on: workflow_dispatch
+
+#on:
+#  pull_request:
+#    branches: [master]
+#    paths: [website/**]
+#  push:
+#    branches: [master]
+#    paths: [website/**]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+          cache: npm
+      - uses: actions/cache@v2
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('REQUIREMENTS.txt') }}-${{ hashFiles('./requirements/DEV_REQUIREMENTS.txt') }}-${{ hashFiles('./requirements/S3_REQUIREMENTS.txt') }}-${{ hashFiles('./requirements/TUNE_REQUIREMENTS.txt') }}-${{ hashFiles('./requirements/TEST_EXTRAS_REQUIREMENTS_REQUIREMENTS.txt') }}
+      - name: Install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[s3,tune]
+          pip install -r ./requirements/DEV_REQUIREMENTS.txt
+          pip install -r ./requirements/S3_REQUIREMENTS.txt
+          pip install -r ./requirements/TUNE_REQUIREMENTS.txt
+          pip install -r ./requirements/TEST_EXTRAS_REQUIREMENTS.txt
+      - name: Test build
+        working-directory: website
+        run: |
+          npm ci
+          yarn build

CONTRIBUTING.md

@@ -7,4 +7,4 @@ Requests in the public repository.
 2. Run black and isort linters before creating a PR.
 3. Any changes to core functionality must pass all existing unit tests.
 4. Additional functionality should have associated unit tests.
-5. Provide documentation ([Numpy Docstring format](https://numpydoc.readthedocs.io/en/latest/format.html#style-guide)) whenever possible, even for simple functions or classes.
+5. Provide documentation ([Google Docstring format](https://google.github.io/styleguide/pyguide.html)) whenever possible, even for simple functions or classes.

NOTICE.txt

@@ -4,7 +4,7 @@
 // ------------------------------------------------------------------
 
 Spock
-Copyright [2019-2021] FMR LLC
+Copyright [2019-2022] FMR LLC
 
 This product includes software developed at
 FMR LLC (https://www.fidelity.com/).
@@ -25,4 +25,18 @@ Optional extensions rely on the following works (and the dependencies thereof),
 - optuna | https://optuna.org/ | MIT License
 - s3transfer | https://github.com/boto/s3transfer | Apache License 2.0
 - torch | https://github.com/pytorch/pytorch | BSD License
-- torchvision | https://github.com/pytorch/vision | BSD 3-Clause License
+- torchvision | https://github.com/pytorch/vision | BSD 3-Clause License
+
+
+Documentation and testing rely on the following works (and the dependencies thereof), installed separately:
+- black | https://github.com/psf/black | MIT License
+- coveralls | https://github.com/TheKevJames/coveralls-python | MIT License
+- coverage | https://github.com/nedbat/coveragepy | Apache License 2.0
+- docusaurus | https://github.com/facebook/docusaurus | MIT License
+- isort | https://github.com/PyCQA/isort | MIT License
+- moto | https://github.com/spulec/moto | Apache License 2.0
+- pydoc-markdown | https://github.com/NiklasRosenstein/pydoc-markdown | MIT License
+- pytest | https://github.com/pytest-dev/pytest | MIT License
+- pytest-cov | https://github.com/pytest-dev/pytest-cov | MIT License
+- pylint | https://github.com/PyCQA/pylint | GPL-2.0 License
+- scikit-learn | https://github.com/scikit-learn/scikit-learn | BSD-3-Clause License

README.md

@@ -2,7 +2,7 @@
 > Managing complex configurations any other way would be highly illogical...
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-9cf)](https://opensource.org/licenses/Apache-2.0)
-[![Python](https://img.shields.io/badge/python-3.6+-informational.svg)]()
+[![Python](https://img.shields.io/badge/python-3.6+-informational.svg)](https://www.python.org/)
 [![Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![PyPI version](https://badge.fury.io/py/spock-config.svg)](https://badge.fury.io/py/spock-config)
 [![Coverage Status](https://coveralls.io/repos/github/fidelity/spock/badge.svg?branch=master)](https://coveralls.io/github/fidelity/spock?branch=master)
@@ -66,8 +66,9 @@ Example `spock` usage is located [here](https://github.com/fidelity/spock/blob/m
 
 See [Releases](https://github.com/fidelity/spock/releases) for more information.
 
-#### December 13, 2021
+#### December 14, 2021
 * Refactored the backend to better handle nested dependencies (and for clarity)
+* Refactored the docs to use Docusaurus
 
 #### August 17, 2021
 * Added hyper-parameter tuning backend support for Ax via Service API