Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add breathe bridge doxygen to sphinx #546

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add breathe bridge doxygen to sphinx #546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/doxygen_config.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
GENERATE_XML = YES
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
Expand Down Expand Up @@ -345,7 +345,7 @@ CLASS_DIAGRAMS = NO
MSCGEN_PATH =
DIA_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
HAVE_DOT = NO
DOT_NUM_THREADS = 0
DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ sphinx-copybutton
sphinx-design
sphinx-inline-tabs
sphinxcontrib-bibtex
breathe
7 changes: 4 additions & 3 deletions doc/sphinx/api_manual/available_apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Available APIs
==============

```{todo}
Show the different APIs which are currently available in the world builder (temperature, composition and CPO. Others will be added as well.)
```
```{eval-rst}
.. doxygenindex::
:outline:
```
4 changes: 3 additions & 1 deletion doc/sphinx/conf.in.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
'sphinx_design',
'sphinx_copybutton',
'sphinxcontrib.bibtex',
'breathe',
]

bibtex_default_style = 'plain'
Expand All @@ -49,6 +50,7 @@

# Breathe Configuration
breathe_default_project = "GWB"
breathe_projects = {"GWB": "../doxygen/xml"}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -87,4 +89,4 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['@CMAKE_CURRENT_SOURCE_DIR@/sphinx/_static/']
html_static_path = ['@CMAKE_CURRENT_SOURCE_DIR@/sphinx/_static/']
16 changes: 13 additions & 3 deletions doc/sphinx/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,18 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
import os
import sys
import subprocess
# sys.path.insert(0, os.path.abspath('.'))

# -- Run Doxygen first if this is a build on ReadTheDocs

read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'

if read_the_docs_build:
os.mkdir("../doxygen")
subprocess.call('cd ../.. ; doxygen doc/doxygen_config.dox', shell=True)

# -- Project information -----------------------------------------------------

Expand All @@ -38,6 +46,7 @@
'sphinx_design',
'sphinx_copybutton',
'sphinxcontrib.bibtex',
'breathe',
]

bibtex_default_style = 'plain'
Expand All @@ -48,6 +57,7 @@

# Breathe Configuration
breathe_default_project = "GWB"
breathe_projects = {"GWB": "../doxygen/xml"}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -86,4 +96,4 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static/']
html_static_path = ['_static/']
Loading