mirror of
https://github.com/davidism/modify-repos.git
synced 2025-08-04 08:58:24 +00:00
write docs
This commit is contained in:
parent
1a6daf27f5
commit
2332be07e5
21 changed files with 983 additions and 17 deletions
47
docs/conf.py
Normal file
47
docs/conf.py
Normal file
|
@ -0,0 +1,47 @@
|
|||
project = "modify-repos"
|
||||
|
||||
default_role = "code"
|
||||
|
||||
extensions = [
|
||||
"myst_parser",
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.extlinks",
|
||||
"sphinx.ext.intersphinx",
|
||||
]
|
||||
|
||||
autodoc_member_order = "bysource"
|
||||
autodoc_typehints = "description"
|
||||
autodoc_preserve_defaults = True
|
||||
|
||||
myst_enable_extensions = [
|
||||
"fieldlist",
|
||||
]
|
||||
myst_heading_anchors = 2
|
||||
|
||||
extlinks = {
|
||||
"issue": ("https://github.com/davidism/modify-repos/issues/%s", "#%s"),
|
||||
"pr": ("https://github.com/davidism/modify-repos/pull/%s", "#%s"),
|
||||
}
|
||||
|
||||
intersphinx_mapping = {
|
||||
"python": ("https://docs.python.org/3/", None),
|
||||
}
|
||||
|
||||
html_theme = "furo"
|
||||
html_static_path = ["_static"]
|
||||
html_css_files = ["theme.css"]
|
||||
html_copy_source = False
|
||||
html_theme_options = {
|
||||
"source_repository": "https://github.com/davidism/modify-repos/",
|
||||
"source_branch": "main",
|
||||
"source_directory": "docs/",
|
||||
"light_css_variables": {
|
||||
"font-stack": "'Atkinson Hyperlegible', sans-serif",
|
||||
"font-stack--monospace": "'Source Code Pro', monospace",
|
||||
},
|
||||
}
|
||||
pygments_style = "default"
|
||||
pygments_style_dark = "github-dark"
|
||||
html_show_copyright = False
|
||||
html_use_index = False
|
||||
html_domain_indices = False
|
Loading…
Add table
Add a link
Reference in a new issue