Skip to content

Commit

Permalink
docs: concept page and theme change
Browse files Browse the repository at this point in the history
  • Loading branch information
camille-004 committed Dec 5, 2024
1 parent 95ab8c4 commit 42e9ff3
Show file tree
Hide file tree
Showing 4 changed files with 585 additions and 11 deletions.
55 changes: 47 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,71 @@
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
"myst_parser",
"sphinx_design", # For grids, cards, tabs
"sphinx_tabs.tabs", # For tab sets
"sphinx_copybutton", # For copy buttons on code blocks
"sphinx_togglebutton", # For dropdowns/toggles
"sphinx_design",
"sphinx_tabs.tabs",
"sphinx_copybutton",
"sphinx_togglebutton",
"sphinx_immaterial",
]


templates_path = ["_templates"]
exclude_patterns = []

# -- Options for HTML output
html_theme = "sphinx_book_theme"
html_theme = "sphinx_immaterial"
html_title = "NanoFed"


html_theme_options = {
"repository_url": "https://github.com/camille-004/nanofed",
"use_repository_button": True,
"use_issues_button": True,
"icon": {"repo": "fontawesome/brands/github"},
"repo_url": "https://github.com/camille-004/nanofed",
"repo_name": "nanofed",
"edit_uri": "blob/main/docs/",
"globaltoc_collapse": False,
"features": [],
"palette": [
{
"media": "(prefers-color-scheme: light)",
"scheme": "default",
"primary": "blue",
"accent": "blue",
},
{
"media": "(prefers-color-scheme: dark)",
"scheme": "slate",
"primary": "blue",
"accent": "blue",
},
],
"social": [
{
"icon": "fontawesome/brands/github",
"link": "https://github.com/camille-004/nanofed",
"name": "GitHub",
},
],
}

# -- Extension configuration
myst_enable_extensions = [
"colon_fence",
"deflist",
"fieldlist",
"html_admonition",
"html_image",
"substitution",
"linkify",
"smartquotes",
]

# Intersphinx mapping
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"torch": ("https://pytorch.org/docs/stable/", None),
}

# Add mermaid CDN
html_js_files = [
('https://cdn.jsdelivr.net/npm/mermaid@latest/dist/mermaid.min.js', {'async': 'async'}),
]
Loading

0 comments on commit 42e9ff3

Please sign in to comment.