diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e1ed5994..427900a9 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,9 +1,9 @@ version: 2 build: - os: "ubuntu-20.04" + os: "ubuntu-22.04" tools: - python: "3.8" + python: "3.11" sphinx: fail_on_warning: false diff --git a/docs/requirements-base.txt b/docs/requirements-base.txt new file mode 100644 index 00000000..c5184bfc --- /dev/null +++ b/docs/requirements-base.txt @@ -0,0 +1,8 @@ +gurobi-sphinxtheme @ git+https://github.com/Gurobi/gurobi-sphinxtheme.git@main + +numpydoc +sphinx-copybutton +sphinx-design +sphinx-tabs +sphinx-toolbox +sphinxcontrib-bibtex diff --git a/docs/requirements.txt b/docs/requirements.txt index bc77919b..708bd2d3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,9 +1,58 @@ -docutils==0.17.1 -Jinja2==3.0.3 -numpydoc==1.5.0 -sphinx-copybutton==0.5.1 -sphinx-design==0.4.1 -sphinx-rtd-theme==1.1.1 -sphinx-tabs==3.4.0 -sphinx-toolbox==3.1.2 -sphinxcontrib-bibtex==2.5.0 +gurobi_sphinxtheme @ git+https://github.com/Gurobi/gurobi-sphinxtheme.git@ca286310140e014d8b8f631e8b5d11f0ed56bebd + +alabaster==0.7.16 +apeye==1.4.1 +apeye-core==1.1.5 +autodocsumm==0.2.12 +Babel==2.15.0 +beautifulsoup4==4.12.3 +CacheControl==0.14.0 +certifi==2024.2.2 +charset-normalizer==3.3.2 +cssutils==2.11.0 +dict2css==0.3.0.post1 +docutils==0.21.2 +domdf-python-tools==3.8.0.post2 +filelock==3.14.0 +furo==2024.1.29 +html5lib==1.1 +idna==3.7 +imagesize==1.4.1 +Jinja2==3.1.4 +latexcodec==3.0.0 +MarkupSafe==2.1.5 +msgpack==1.0.8 +natsort==8.4.0 +numpydoc==1.7.0 +packaging==24.0 +platformdirs==4.2.2 +pybtex==0.24.0 +pybtex-docutils==1.0.3 +Pygments==2.18.0 +PyYAML==6.0.1 +requests==2.31.0 +ruamel.yaml==0.18.6 +ruamel.yaml.clib==0.2.8 +six==1.16.0 +snowballstemmer==2.2.0 +soupsieve==2.5 +Sphinx==7.3.7 +sphinx-autodoc-typehints==2.1.0 +sphinx-basic-ng==1.0.0b2 +sphinx-copybutton==0.5.2 +sphinx-jinja2-compat==0.2.0.post1 +sphinx-prompt==1.8.0 +sphinx-tabs==3.4.5 +sphinx-toolbox==3.5.0 +sphinx_design==0.5.0 +sphinxcontrib-applehelp==1.0.8 +sphinxcontrib-bibtex==2.6.2 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 +tabulate==0.9.0 +typing_extensions==4.11.0 +urllib3==2.2.1 +webencodings==0.5.1 diff --git a/docs/source/conf.py b/docs/source/conf.py index 1d4ec5b5..f4fcb393 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,7 +44,13 @@ templates_path = ["_templates"] -html_theme = "sphinx_rtd_theme" +html_theme = "gurobi_sphinxtheme" +html_theme_options = { + "version_warning": False, + "feedback_banner": False, + "construction_warning": False, +} +html_favicon = "https://www.gurobi.com/favicon.ico" autosectionlabel_prefix_document = True