Merge pull request #78 from stefmolin/publish-docs

Changes in preparation to publish docs


skip-checks: true

.gitignore

@@ -27,7 +27,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
-generated/
+docs/api/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

docs/README.md

@@ -1,6 +1,4 @@
 # Docs
 
 1. Install the docs dependencies: `pip install '.[docs]'`.
-2. From this directory, run `python3 -m sphinx -b html . build`.
-
-*Note: Remove the `generated` directory to start fresh, if needed.*
+2. From this directory, run `python3 -m sphinx -b html . _build/<version>`.

docs/_static/switcher.json

@@ -0,0 +1,12 @@
+[
+    {
+        "name": "v0.1.0 (stable)",
+        "version": "0.1.0",
+        "url": "https://stefmolin.github.io/data-morph/0.1.0/index.html"
+    },
+    {
+        "name": "dev",
+        "version": "dev",
+        "url": "https://stefmolin.github.io/data-morph/main/index.html"
+    }
+]

docs/api.rst

@@ -6,7 +6,7 @@ API
 .. rubric:: Modules
 
 .. autosummary::
-   :toctree: generated
+   :toctree: api
    :recursive:
 
    data_morph.bounds

docs/conf.py

@@ -12,9 +12,7 @@
 
 project = 'Data Morph'
 current_year = dt.date.today().year
-copyright = (
-    f'2023{f"-{current_year}" if current_year != 2023 else ""}, ' 'Stefanie Molin'
-)
+copyright = f'2023{f"-{current_year}" if current_year != 2023 else ""}, Stefanie Molin'
 author = 'Stefanie Molin'
 release = data_morph.__version__
 
@@ -93,22 +91,19 @@
 html_favicon = '_static/favicon.ico'
 
 html_theme_options = {
-    "github_url": "https://github.com/stefmolin/data-morph",
-    "twitter_url": "https://twitter.com/StefanieMolin",
-    "show_toc_level": 1,
-    "navbar_align": "left",
-    # "navbar_center": ["version-switcher", "navbar-nav"],
-    # "switcher": {
-    #     "json_url": json_url,
-    #     "version_match": version_match,
-    # },
+    'github_url': 'https://github.com/stefmolin/data-morph',
+    'twitter_url': 'https://twitter.com/StefanieMolin',
+    'show_toc_level': 1,
+    'navbar_align': 'left',
+    'navbar_center': ['version-switcher', 'navbar-nav'],
+    'switcher': {'json_url': '_static/switcher.json', 'version_match': release},
 }
 
 html_context = {
-    "github_user": "stefmolin",
-    "github_repo": "data-morph",
-    "github_version": "main",
-    "doc_path": "docs",
+    'github_user': 'stefmolin',
+    'github_repo': 'data-morph',
+    'github_version': 'main',
+    'doc_path': 'docs',
 }
 
 

pyproject.toml

@@ -10,7 +10,7 @@ authors = [
     {name = "Justin Matejka", email = "[email protected]"}
 ]
 maintainers = [
-    {name = "Stefanie Molin", email = "[email protected]"},
+    {name = "Stefanie Molin"},
 ]
 description = "Teaching tool on the importance of data visualization."
 readme = "README.rst"