cocobird1 · cocobird1 · Apr 11, 2023 · Apr 11, 2023 · Apr 11, 2023 · Apr 11, 2023
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,42 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+      - docs
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: write
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: "pip"
+        cache-dependency-path: 'pyproject.toml'
+
+    - name: Install dependencies
+      run: |
+        make develop
+
+    - name: Build docs
+      run: |
+        make docs
+
+    - name: Deploy to gh-pages branch
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/build/html
diff --git a/.gitignore b/.gitignore
@@ -11,6 +11,7 @@ __pycache__/
 build/
 develop-eggs/
 dist/
+*.tar.gz
 downloads/
 eggs/
 .eggs/
@@ -127,3 +128,8 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+
+# Mac files
+.DS_Store
+
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,7 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": []
+}
diff --git a/Makefile b/Makefile
@@ -77,6 +77,12 @@ dist: clean build dist-build dist-check  ## Build dists
 publish:  # Upload python assets
 	echo "would usually run python -m twine upload dist/* --skip-existing"
 
+########
+# DOCS #
+########
+docs: ## build the documentation
+	make -C docs html
+
 #########
 # CLEAN #
 #########
@@ -96,4 +102,4 @@ help:
 print-%:
 	@echo '$*=$($*)'
 
-.PHONY: develop build install lint lints format fix check checks annotate test coverage show-coverage tests show-version patch minor major dist-build dist-check dist publish deep-clean clean help
+.PHONY: develop build install lint lints format fix check checks annotate test coverage show-coverage tests show-version patch minor major dist-build dist-check dist publish deep-clean clean help docs
diff --git a/dist/fantasyfootball-crawler-0.1.0.tar.gz b/dist/fantasyfootball-crawler-0.1.0.tar.gz
diff --git a/website/docs/Makefile → docs/Makefile b/website/docs/Makefile → docs/Makefile
@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
+SOURCEDIR     = .
 BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/website/docs/source/conf.py → docs/conf.py b/website/docs/source/conf.py → docs/conf.py
@@ -4,8 +4,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 import os
 import sys
-import bs4
-sys.path.insert(0, os.path.abspath('../../../fantasyfootball-crawler'))
+sys.path.insert(0, os.path.abspath('../'))
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 

diff --git a/website/docs/source/index.rst → docs/index.rst b/website/docs/source/index.rst → docs/index.rst
@@ -4,5 +4,5 @@
    contain the root `toctree` directive.
 
 .. include:: intro.rst
-.. automodule:: ff_functions
+.. automodule:: fantasyfootball_crawler.ff_functions
     :members:
diff --git a/website/docs/source/intro.rst → docs/intro.rst b/website/docs/source/intro.rst → docs/intro.rst
diff --git a/website/docs/make.bat → docs/make.bat b/website/docs/make.bat → docs/make.bat
diff --git a/website/docs/modules.rst → docs/modules.rst b/website/docs/modules.rst → docs/modules.rst
diff --git a/fantasyfootball-crawler/tests/__init__.py b/fantasyfootball-crawler/tests/__init__.py
diff --git a/__init__.py → fantasyfootball_crawler/__init__.py b/__init__.py → fantasyfootball_crawler/__init__.py
diff --git a/fantasyfootball-crawler/__main__.py → fantasyfootball_crawler/__main__.py b/fantasyfootball-crawler/__main__.py → fantasyfootball_crawler/__main__.py
diff --git a/fantasyfootball-crawler/_version.py → fantasyfootball_crawler/_version.py b/fantasyfootball-crawler/_version.py → fantasyfootball_crawler/_version.py
diff --git a/fantasyfootball-crawler/ff_functions.py → fantasyfootball_crawler/ff_functions.py b/fantasyfootball-crawler/ff_functions.py → fantasyfootball_crawler/ff_functions.py
diff --git a/fantasyfootball-crawler/__init__.py → fantasyfootball_crawler/tests/__init__.py b/fantasyfootball-crawler/__init__.py → fantasyfootball_crawler/tests/__init__.py
diff --git a/fantasyfootball-crawler/tests/test_all.py → fantasyfootball_crawler/tests/test_all.py b/fantasyfootball-crawler/tests/test_all.py → fantasyfootball_crawler/tests/test_all.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,6 +46,7 @@ develop = [
     "mypy",
     "pytest>=4.3.0",
     "pytest-cov>=2.6.1",
+    "sphinx",
     "twine",
     "wheel",
 ]

diff --git a/website/.DS_Store b/website/.DS_Store
diff --git a/website/docs/.DS_Store b/website/docs/.DS_Store
diff --git a/website/docs/build/.DS_Store b/website/docs/build/.DS_Store
diff --git a/website/docs/build/doctrees/environment.pickle b/website/docs/build/doctrees/environment.pickle
diff --git a/website/docs/build/doctrees/index.doctree b/website/docs/build/doctrees/index.doctree
diff --git a/website/docs/build/doctrees/intro.doctree b/website/docs/build/doctrees/intro.doctree
diff --git a/website/docs/build/html/.buildinfo b/website/docs/build/html/.buildinfo
diff --git a/website/docs/build/html/.doctrees/environment.pickle b/website/docs/build/html/.doctrees/environment.pickle
diff --git a/website/docs/build/html/.doctrees/index.doctree b/website/docs/build/html/.doctrees/index.doctree
diff --git a/website/docs/build/html/_sources/index.rst.txt b/website/docs/build/html/_sources/index.rst.txt
diff --git a/website/docs/build/html/_sources/intro.rst.txt b/website/docs/build/html/_sources/intro.rst.txt