Bugfix/update doc dependencies (#365)

tora-kozic · web-flow · commit ba0aa54a41a4 · 2022-04-25T15:18:11.000-05:00
* update doc dependencies

* fix sphinx

* update myst-parser
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,22 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+python:
+   version: 3.7
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+           - dev
+           - docs
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -45,12 +45,12 @@ eval "$(pyenv virtualenv-init -)"
 Then, create your virtual environment.
 
 ```bash
-pyenv install 3.6.10
-pyenv virtualenv 3.6.10 code42cli
+pyenv install 3.9.10
+pyenv virtualenv 3.9.10 code42cli
 pyenv activate code42cli
 ```
 
-**Note**: The CLI supports pythons versions 3.6 through 3.9 - any versions within that range should work for your virtual environment.  Use `pyenv --versions` to see all versions available for install. There are some known issues installing python 3.6 with pyenv on certain OS.
+**Note**: The CLI supports pythons versions 3.6 through 3.9 for end users. However due to some of the build dependencies, you'll need a version >=3.7 for your virtual environment.  Use `pyenv --versions` to see all versions available for install. There are some known issues installing python 3.6 with pyenv on certain OS.
 
 Use `source deactivate` to exit the virtual environment and `pyenv activate code42cli` to reactivate it.
 
@@ -174,7 +174,7 @@ tox -e docs
 To build and run the documentation locally, run the following from the `docs` directory:
 
 ```bash
-pip install sphinx myst_parser sphinx_rtd_theme
+pip install sphinx myst-parser sphinx_rtd_theme
 make html
 ```
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "code42cli"
-copyright = "2020, Code42 Software"
+copyright = "2022, Code42 Software"
 author = "Code42 Software"
 
 # The short X.Y version
@@ -30,7 +30,7 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-# needs_sphinx = '1.0'
+needs_sphinx = "4.4.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -71,6 +71,8 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
 
+# generate header anchors
+myst_heading_anchors = 4
 
 # -- Options for HTML output -------------------------------------------------
 
diff --git a/setup.py b/setup.py
@@ -48,7 +48,13 @@
             "pytest-cov==2.10.0",
             "pytest-mock==2.0.0",
             "tox>=3.17.1",
-        ]
+        ],
+        "docs": [
+            "sphinx==4.4.0",
+            "myst-parser==0.16",
+            "sphinx_rtd_theme==1.0.0",
+            "sphinx-click",
+        ],
     },
     classifiers=[
         "Intended Audience :: Developers",
diff --git a/tox.ini b/tox.ini
@@ -25,8 +25,8 @@ commands =
 [testenv:docs]
 deps =
     sphinx == 4.4.0
-    myst_parser == 0.16
-    sphinx_rtd_theme == 0.5.2
+    myst-parser == 0.17.2
+    sphinx_rtd_theme == 1.0.0
     sphinx-click
 whitelist_externals = bash
 
