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 pyproject metadata and docs theme/links #13

Merged
merged 3 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
23 changes: 22 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,35 @@
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"collapse_navigation": True
"collapse_navigation": True,
"logo": {
"alt_text": "obsidian - Home",
"text": "obsidian APO",
"image_light": "_static/obsidian_logo.png",
"image_dark": "_static/obsidian_logo.png",
},
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/MSDLLCpapers/obsidian/",
"icon": "fa-brands fa-github",
"type": "fontawesome",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/obsidian-apo/",
"icon": "fa-brands fa-python",
"type": "fontawesome",
},
]
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = ["mycss.css"]
html_favicon = "_static/obsidian_logo.png"

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@

.. toctree::
:hidden:
:maxdepth: 2

GitHub <https://github.com/MSDLLCpapers/obsidian/>

stubs/api_docs

.. toctree::
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name = "obsidian-apo"
version = "0.7.12"
description = "Automated experiment design and black-box optimization"
authors = [
{name = "Kevin Stone, email = "kevin.stone38@gmail.com"},
{name = "Yuting Xu", email = "yuting.xu@merck.com"}
"Kevin Stone <kevin.stone38@gmail.com>",
"Yuting Xu <yuting.xu@merck.com>"
]
packages = [
{ include = "obsidian" },
Expand Down
Loading