Skip to content

Commit

Permalink
Update mkdocs config based on textual's
Browse files Browse the repository at this point in the history
  • Loading branch information
p-j-smith committed Sep 10, 2023
1 parent 6b62fc4 commit a7aa5da
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
73 changes: 73 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,76 @@
site_name: MDAnalysis TUI

markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- md_in_html
- admonition
- def_list
- meta

- toc:
permalink: true
baselevel: 1
- pymdownx.keys
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets
- markdown.extensions.attr_list

theme:
name: material
features:
- navigation.tabs
- navigation.indexes
- navigation.tabs.sticky
- navigation.footer
- content.code.annotate
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/weather-night
name: Switch to light mode

plugins:
search:
autorefs:
mkdocstrings:
default_handler: python
handlers:
python:
options:
show_signature_annotations: false
separate_signature: true
merge_init_into_class: true
docstring_options:
ignore_init_summary: true
show_source: false
filters:
- "!^_"
- "^__init__$"
- "!^can_replace$"

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/p-j-smith/mda-tui/
name: MDAnalysis TUI on Github
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ test = [
doc = [
"mkdocs",
"mkdocs-material",
"mkdocstrings[python]",
"mkdocstrings-python",
"mkdocs-exclude",
"mkdocs-rss-plugin",
]
dev =[
"mda-tui[test,doc]",
Expand Down

0 comments on commit a7aa5da

Please sign in to comment.