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

docs: better layout #4

Merged
merged 1 commit into from
Mar 19, 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
2 changes: 2 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
::: qcmanybody.ManyBodyCalculator

Binary file added docs/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:root {
--md-primary-fg-color: #96B4B2;
--md-primary-fg-color--light: #96B4B2;
--md-primary-fg-color--dark: #96B4B2;
}
43 changes: 42 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,60 @@
site_name: QCManyBody Docs
site_url: https://molssi.github.io/QCManyBody/

repo_name: MolSSI/QCManyBody
repo_url: https://github.com/MolSSI/QCManyBody
edit_uri: edit/main/docs/

copyright: Copyright © 2024 QCManyBody Developers

theme:
name: "material"
name: material
logo: logo.png
favicon: logo.png
features:
- navigation.tabs

palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
#accent: pink
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/lightbulb
name: "Switch to light mode"

extra_css:
- stylesheets/extra.css

plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [.]
options:
docstring_style: numpy
allow_inspection: true
import:
- https://docs.python.org/3.12/objects.inv
- https://numpy.org/doc/stable/objects.inv
- https://docs.scipy.org/doc/scipy/objects.inv
- https://matplotlib.org/stable/objects.inv
- https://molssi.github.io/QCElemental/objects.inv
- https://molssi.github.io/QCEngine/objects.inv
- https://molssi.github.io/QCFractal/objects.inv

nav:
- QCManyBody Docs: index.md
- tutorials.md
- API Documentation: api.md
- How-To Guides: how-to-guides.md
- reference.md
- explanation.md
Expand Down
Loading