Skip to content

Commit

Permalink
Update conf.py and command to build.
Browse files Browse the repository at this point in the history
  • Loading branch information
stefmolin committed Apr 1, 2023
1 parent 18f2b15 commit 75e06c9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 19 deletions.
4 changes: 1 addition & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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>`.
27 changes: 11 additions & 16 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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__

Expand Down Expand Up @@ -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',
}


Expand Down

0 comments on commit 75e06c9

Please sign in to comment.