diff --git a/python/docs/conf.py b/python/docs/conf.py index 46aaa774..e88bb385 100644 --- a/python/docs/conf.py +++ b/python/docs/conf.py @@ -19,18 +19,18 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx_rtd_theme' + 'sphinx.ext.intersphinx' ] exclude_patterns = ["build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- -html_theme = "sphinx_rtd_theme" +html_permalinks_icon = '#' +html_theme = "sphinxawesome_theme" html_static_path = [] -html_logo = "https://raw.githubusercontent.com/rudof-project/rudof-project.github.io/refs/heads/main/images/rudof_logo3.svg" -html_favicon = "https://raw.githubusercontent.com/rudof-project/rudof-project.github.io/refs/heads/main/images/rudof_logo3.svg" +html_logo = "https://raw.githubusercontent.com/rudof-project/rudof/refs/heads/master/docs/src/assets/corp/logo.svg" +html_favicon = "https://raw.githubusercontent.com/rudof-project/rudof/refs/heads/master/docs/src/assets/corp/logo.svg" html_theme_options = {"body_max_width": None} html_baseurl = "https://pyrudof.readthedocs.io/en/stable/" diff --git a/python/docs/index.rst b/python/docs/index.rst index aa35ca1d..0ee0b819 100644 --- a/python/docs/index.rst +++ b/python/docs/index.rst @@ -11,6 +11,7 @@ Installation ``pyrudof`` is available on `PyPI `_ and can be installed by running the usual ``pip install pyrudof``, which will install the latest version currently available. :: + from pyrudof import * rudof = Rudof(RudofConfig()) diff --git a/python/requirements.dev.txt b/python/requirements.dev.txt index f316c3b8..ebd76531 100644 --- a/python/requirements.dev.txt +++ b/python/requirements.dev.txt @@ -3,4 +3,4 @@ mypy~=1.0 ruff~=0.7.0 sphinx~=7.0 sphinx-lint~=1.0 -sphinx-rtd-theme~=3.0.1 \ No newline at end of file +sphinxawesome-theme~=5.3.1 \ No newline at end of file