Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2025-08-04 01:34:12 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Some release preparation janitoring (#432)

Browse Source 
* Use myst-parser for readme.md doc injection

* Relax version pins

* Define bug tracker and doc links for pypi

* Update pre-commit hooks
This commit is contained in:
Teemu R
2023-02-18 22:09:35 +01:00
committed by GitHub
parent 016f4dfd19
commit 02c857d472
8 changed files with 626 additions and 419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/conf.py
View File

@@ -33,6 +33,7 @@ extensions = [
"sphinx.ext.viewcode",
"sphinx.ext.todo",
"sphinxcontrib.programoutput",
"myst_parser",
]
# Add any paths that contain templates here, relative to this directory.
@@ -62,12 +63,3 @@ todo_include_todos = True
def setup(app):
# add copybutton to hide the >>> prompts, see https://github.com/readthedocs/sphinx_rtd_theme/issues/167
app.add_js_file("copybutton.js")
# see https://github.com/readthedocs/recommonmark/issues/191#issuecomment-622369992
from m2r import MdInclude
app.add_config_value("no_underscore_emphasis", False, "env")
app.add_config_value("m2r_parse_relative_links", False, "env")
app.add_config_value("m2r_anonymous_references", False, "env")
app.add_config_value("m2r_disable_inline_math", False, "env")
app.add_directive("mdinclude", MdInclude)

3
docs/source/index.rst
View File

@@ -1,4 +1,5 @@
.. mdinclude:: ../../README.md
.. include:: ../../README.md
:parser: myst_parser.sphinx_
.. toctree::
:maxdepth: 2