diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/_templates/copying.html | 0 | ||||
| -rw-r--r-- | docs/source/about/changelog.md | 1 | ||||
| -rw-r--r-- | docs/source/about/index.rst | 5 | ||||
| -rw-r--r-- | docs/source/about/introduction.rst | 14 | ||||
| -rw-r--r-- | docs/source/conf.py | 30 |
5 files changed, 34 insertions, 16 deletions
diff --git a/docs/source/_templates/copying.html b/docs/source/_templates/copying.html new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/source/_templates/copying.html diff --git a/docs/source/about/changelog.md b/docs/source/about/changelog.md index 2a5406d..6439e95 100644 --- a/docs/source/about/changelog.md +++ b/docs/source/about/changelog.md @@ -10,4 +10,5 @@ https://en.wikipedia.org/wiki/Lists_of_colors --> ```{include} ../../../CHANGELOG.md +:tocdepth: 2 ```
\ No newline at end of file diff --git a/docs/source/about/index.rst b/docs/source/about/index.rst index 9a37734..0bf07f1 100644 --- a/docs/source/about/index.rst +++ b/docs/source/about/index.rst @@ -2,7 +2,7 @@ ==== .. toctree:: - :hidden: + .. :hidden: introduction list_of_features @@ -10,4 +10,5 @@ faq complying_with_licenses release_policy - changelog
\ No newline at end of file + changelog + diff --git a/docs/source/about/introduction.rst b/docs/source/about/introduction.rst index 02c627a..ff01d3d 100644 --- a/docs/source/about/introduction.rst +++ b/docs/source/about/introduction.rst @@ -1,6 +1,20 @@ 前言 ==== +.. code-block:: nivis + + if: contained!(event.message, r"Hello") => p", World!" ? false; + + +.. code-block:: rust + + fn main() { + println!("Hello, world!"); + } + + +:issue:`23` + 在开始之前 ---------------------------- diff --git a/docs/source/conf.py b/docs/source/conf.py index 625f99a..4496f04 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -40,25 +40,34 @@ extensions = [ "sphinx.ext.napoleon", "sphinx.ext.autosummary", "sphinx.ext.extlinks", + "sphinx.ext.intersphinx", "myst_parser", ] +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] extlinks = { - "issue": ("https://github.com/HydroRoll-Team/HydroRoll/%s", "issue %s"), - "doc": ("https://docs.hydroroll.team/zh_CN/latest/%s", "pages/%s"), + "issue": ("https://github.com/HydroRoll-Team/HydroRoll/issues/%s", "[issue %s]"), } source_suffix = { ".rst": "restructuredtext", ".txt": "markdown", ".md": "markdown", } - +rst_epilog = """ +.. |psf| replace:: Python Software Foundation +""" locale_dirs = ["../locales/"] # path is example but recommended. gettext_compact = False # optional. gettext_uuid = True # optional. - +numfig = True # Figures, tables and code blocks are automatically numbered if they have a title +pygments_style = "colorful" # default sphinx, change the style of code block +math_number_all = True # Number all equations, figures, tables and code blocks +html_additional_pages = { + 'copy': 'copying.html', +} +html_split_index = True # Split the index page by each alphabet # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output @@ -106,13 +115,6 @@ html_theme_options = { } # html_sidebars = { -# "**": [ -# "sidebar/scroll-start.html", -# "sidebar/brand.html", -# "sidebar/search.html", -# "sidebar/navigation.html", -# "sidebar/ethical-ads.html", -# "sidebar/scroll-end.html", -# ] -# } - +# '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html', 'relations.html'], +# 'using/windows': ['windowssidebar.html', 'searchbox.html'], +# }
\ No newline at end of file |
