Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the footer issue on the docs home page, and update the docs #81

Merged
merged 3 commits into from
May 4, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: update the doc configurations;
  • Loading branch information
WenjieDu committed May 4, 2023
commit 61be406a7478de917b8d3fdfea84aaeb590fcd06
20 changes: 18 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
# -- Project information -----------------------------------------------------
project = "PyPOTS"
author = "Wenjie Du"
copyright = f"{datetime.datetime.now().year}, {author}"
date_now = datetime.datetime.now()
copyright = f"{date_now.year}, {author}"

# The full version, including alpha/beta/rc tags
release = pypots.__version__
Expand Down Expand Up @@ -72,11 +73,26 @@
html_static_path = ["_static"]

html_context = {
"last_updated": True,
"last_updated": f"{date_now.year}/{date_now.month}/{date_now.day}",
}

# https://pradyunsg.me/furo/customisation/#top-of-page-button
# Controls which button is shown on the top of the page. The only supported values are "edit" (the default) and None.
html_theme_options = {
"top_of_page_button": None,
}

html_sidebars = {
"**": [
"sidebar/scroll-start.html",
"sidebar/brand.html",
"sidebar/search.html",
"sidebar/navigation.html",
"sidebar/scroll-end.html",
]
}

intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"sphinx": ("https://www.sphinx-doc.org/en/master", None),
}