From 793c863e8293ea0d8f9c262118e04e91a3df093e Mon Sep 17 00:00:00 2001 From: Jesper Friis Date: Tue, 23 Jan 2024 23:02:37 +0100 Subject: [PATCH] Update doc requirements --- .github/workflows/cd_docs.yml | 13 ++++-- .github/workflows/cd_release.yml | 2 +- doc/Doxyfile.in | 78 -------------------------------- doc/conf.py.in | 2 +- requirements_doc.txt | 15 +++--- 5 files changed, 20 insertions(+), 90 deletions(-) diff --git a/.github/workflows/cd_docs.yml b/.github/workflows/cd_docs.yml index e2193b884..595db39ee 100644 --- a/.github/workflows/cd_docs.yml +++ b/.github/workflows/cd_docs.yml @@ -54,15 +54,20 @@ jobs: python3-dev \ python3-numpy \ python3-yaml - # python3-psycopg2 - python3 -m pip install psycopg2-binary==2.9.5 + #python3 -m pip install psycopg2-binary==2.9.5 + + - name: Available version of installed programs + run: | + python --version + swig -version + doxygen --version + dot --version - name: Install Python dependencies run: | pip install --upgrade pip pip install -U setuptools wheel - pip install -r requirements.txt - pip install -r requirements_doc.txt + pip install -r requirements.txt -r requirements_doc.txt - name: Run CMAKE run: | diff --git a/.github/workflows/cd_release.yml b/.github/workflows/cd_release.yml index c96adcc21..9db566794 100644 --- a/.github/workflows/cd_release.yml +++ b/.github/workflows/cd_release.yml @@ -42,7 +42,7 @@ jobs: with: token: ${{ secrets.RELEASE_PAT }} branch: ${{ env.PUBLISH_UPDATE_BRANCH }} - sleep: 15 + pre_sleep: 15 force: true tags: true unprotect_reviews: true diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 1fceee2ed..3ecda1361 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1438,17 +1438,6 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX @@ -1727,16 +1716,6 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. @@ -1809,16 +1788,6 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code -# with syntax highlighting in the RTF output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_SOURCE_CODE = NO - #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- @@ -1908,15 +1877,6 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -2097,15 +2057,6 @@ EXTERNAL_PAGES = YES # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2138,23 +2089,6 @@ HAVE_DOT = YES DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_FONTSIZE = 10 - # By default doxygen will tell dot to use the default font as specified with # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set # the path where dot can find it using this tag. @@ -2367,18 +2301,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support diff --git a/doc/conf.py.in b/doc/conf.py.in index e3707df94..03b48440c 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -22,7 +22,7 @@ if TYPE_CHECKING: # pragma: no cover root_doc = "index" templates_path = ['_templates'] project = "DLite" -copyright = "© SINTEF 2022" +copyright = "© SINTEF 2024" author = "SINTEF" version ="@dlite_VERSION@" diff --git a/requirements_doc.txt b/requirements_doc.txt index d045f3828..1d60ec171 100644 --- a/requirements_doc.txt +++ b/requirements_doc.txt @@ -1,18 +1,21 @@ importlib-metadata==4.13.0; python_version<'3.8' -breathe>=4.34.0 beautifulsoup4>=4.11.1 lxml>=4.7.1 -myst-nb~=0.17.1 -Sphinx>=4.5.0,<5 +#Sphinx>=4.5.0,<5 +Sphinx>5.0,<6 + +breathe>=4.34.0 +myst-nb~=0.17.1 sphinx-autoapi~=2.0 sphinx-autobuild~=2021.3.14 -sphinx-book-theme~=0.3.3 +#sphinx-book-theme~=0.3.3 +sphinx-book-theme~=1.0.1 sphinx-toggleprompt~=0.4.0 -# sphinx-copybutton~=0.5.1 # does not work well with toggleprompt +## sphinx-copybutton~=0.5.1 # does not work well with toggleprompt sphinx-design~=0.3.0 -sphinxcontrib-plantuml~=0.24 +sphinxcontrib-plantuml~=0.26 nbclient>=0.2,<0.10