diff --git a/docs/conf.py b/docs/conf.py index 34a597d..04fd398 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,6 @@ "sphinx.ext.todo", "sphinx.ext.viewcode", "enum_tools.autoenum", - "sphinxjp.themes.basicstrap", ] templates_path = ["_templates"] @@ -71,9 +70,13 @@ # -- Options for HTML output ---------------------------------------------- -html_theme = 'basicstrap' +# Docs about theme https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/install.html +html_theme = 'sphinx_book_theme' html_theme_options = { - 'sidebar_span': 1, + "repository_url": "https://github.com/cyberstudio/cybsi-sdk", + "use_repository_button": True, + "use_issues_button": True, + 'secondary_sidebar_items': [], } html_static_path = ["_static"] diff --git a/docs/requirements.txt b/docs/requirements.txt index 2b0ced4..77a8069 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,7 +4,7 @@ Sphinx==4.2.0 sphinx_toolbox==2.16.0 sphinx-autodoc-typehints==1.11.1 enum_tools==0.11.0 -sphinxjp.themes.basicstrap==0.5.0 +sphinx-book-theme==1.0.1 httpx==0.23.1 sphinx-jinja2-compat==0.1.1 aiofiles==22.1.0 diff --git a/poetry.lock b/poetry.lock index 5992a45..05bbee3 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,3 +1,14 @@ +[[package]] +name = "accessible-pygments" +version = "0.0.4" +description = "A collection of accessible pygments styles" +category = "dev" +optional = false +python-versions = "*" + +[package.dependencies] +pygments = ">=1.5" + [[package]] name = "aiofiles" version = "22.1.0" @@ -713,6 +724,29 @@ category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +[[package]] +name = "pydata-sphinx-theme" +version = "0.13.3" +description = "Bootstrap-based Sphinx theme from the PyData community" +category = "dev" +optional = false +python-versions = ">=3.7" + +[package.dependencies] +accessible-pygments = "*" +Babel = "*" +beautifulsoup4 = "*" +docutils = "!=0.17.0" +packaging = "*" +pygments = ">=2.7" +sphinx = ">=4.2" +typing-extensions = "*" + +[package.extras] +doc = ["numpydoc", "myst-nb", "linkify-it-py", "rich", "sphinxext-rediraffe", "sphinx-sitemap", "ablog (>=0.11.0rc2)", "jupyter-sphinx", "pandas", "plotly", "matplotlib", "numpy", "xarray", "sphinx-copybutton", "sphinx-design", "sphinx-togglebutton", "sphinxcontrib-youtube", "sphinx-favicon (>=1.0.1)", "nbsphinx", "ipyleaflet", "colorama"] +test = ["pytest", "pytest-cov", "pytest-regressions", "codecov"] +dev = ["pyyaml", "pre-commit", "nox", "pydata-sphinx-theme"] + [[package]] name = "pyflakes" version = "2.4.0" @@ -904,6 +938,23 @@ Sphinx = ">=3.0" test = ["pytest (>=3.1.0)", "typing-extensions (>=3.5)", "sphobjinv (>=2.0)", "Sphinx (>=3.2.0)", "dataclasses"] type_comments = ["typed-ast (>=1.4.0)"] +[[package]] +name = "sphinx-book-theme" +version = "1.0.1" +description = "A clean book theme for scientific explanations and documentation with Sphinx" +category = "dev" +optional = false +python-versions = ">=3.7" + +[package.dependencies] +pydata-sphinx-theme = ">=0.13.3" +sphinx = ">=4,<7" + +[package.extras] +code-style = ["pre-commit"] +doc = ["ablog", "ipywidgets", "folium", "numpy", "matplotlib", "numpydoc", "myst-nb", "nbclient", "pandas", "plotly", "sphinx-design", "sphinx-examples", "sphinx-copybutton", "sphinx-tabs (<=3.4.0)", "docutils (==0.17.1)", "sphinx-togglebutton", "sphinx-thebe", "sphinxcontrib-bibtex", "sphinxcontrib-youtube", "sphinxext-opengraph"] +test = ["beautifulsoup4", "coverage", "myst-nb", "pytest", "pytest-cov", "pytest-regressions", "sphinx-thebe"] + [[package]] name = "sphinx-jinja2-compat" version = "0.1.1" @@ -1049,17 +1100,6 @@ python-versions = ">=3.5" lint = ["flake8", "mypy", "docutils-stubs"] test = ["pytest"] -[[package]] -name = "sphinxjp.themes.basicstrap" -version = "0.5.0" -description = "A sphinx theme for Basicstrap style. Using Twitter Bootstrap. #sphinxjp" -category = "dev" -optional = false -python-versions = "*" - -[package.dependencies] -Sphinx = "*" - [[package]] name = "tabulate" version = "0.8.10" @@ -1195,9 +1235,10 @@ testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "flake8 (<5)", "pytest-co [metadata] lock-version = "1.1" python-versions = "^3.7" -content-hash = "2fc7478db66051579aa23240df12a399d2d5646390810e0dc7da9f40c066b1b4" +content-hash = "48658aafc75cca015ebb06e623b6e00272dbdad2078f6c41de1674bac2d26d0a" [metadata.files] +accessible-pygments = [] aiofiles = [] aiohttp = [] aiosignal = [] @@ -1256,6 +1297,7 @@ pathspec = [] platformdirs = [] pluggy = [] pycodestyle = [] +pydata-sphinx-theme = [] pyflakes = [] pygments = [] pytest = [] @@ -1271,6 +1313,7 @@ snowballstemmer = [] soupsieve = [] sphinx = [] sphinx-autodoc-typehints = [] +sphinx-book-theme = [] sphinx-jinja2-compat = [] sphinx-prompt = [] sphinx-tabs = [] @@ -1281,7 +1324,6 @@ sphinxcontrib-htmlhelp = [] sphinxcontrib-jsmath = [] sphinxcontrib-qthelp = [] sphinxcontrib-serializinghtml = [] -"sphinxjp.themes.basicstrap" = [] tabulate = [] tbump = [] tomli = [] diff --git a/pyproject.toml b/pyproject.toml index 9114d1f..26e1db4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,7 +25,7 @@ flake8 = "4.0.1" mypy = "0.991" Sphinx = "4.2.0" sphinx_toolbox = "2.16.0" -"sphinxjp.themes.basicstrap" = "0.5.0" +sphinx-book-theme = "^1.0.1" sphinx-autodoc-typehints = "1.11.1" pytest = "^7.1.1" tbump = "6.8.0"