diff options
| author |  MaxThevenet <mthevenet@lbl.gov>
| 2020-01-08 10:34:37 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-01-08 10:34:37 -0800 |
| commit | bc0fc9548e6768b454310cbc21d0d2cfcf4b72f0 (patch) | |
| tree | 839e2ad68735c276fc6be85c0263fe21c4f54ce0 | |
| parent | f39e64a5b6aa80a3e89b373af0ba963c0768f580 (diff) | |
| parent | 82526e1570c3f0e65da21f9407112db9868609bc (diff) | |
| download | WarpX-bc0fc9548e6768b454310cbc21d0d2cfcf4b72f0.tar.gz WarpX-bc0fc9548e6768b454310cbc21d0d2cfcf4b72f0.tar.zst WarpX-bc0fc9548e6768b454310cbc21d0d2cfcf4b72f0.zip | |
Merge pull request #602 from ax3l/doc-doxypageInSphinx
Doxygen: Add HTML to _static Sphinx Dir
| -rw-r--r-- | Docs/source/conf.py | 4 | ||||
| -rw-r--r-- | Docs/source/developers/developers.rst | 2 | ||||
| -rw-r--r-- | Docs/source/developers/documentation.rst | 2 |
3 files changed, 6 insertions, 2 deletions
diff --git a/Docs/source/conf.py b/Docs/source/conf.py index 4a4716b66..f4d487aab 100644 --- a/Docs/source/conf.py +++ b/Docs/source/conf.py @@ -100,7 +100,7 @@ numfig = True # 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'] # -- Options for HTMLHelp output ------------------------------------------ @@ -194,4 +194,4 @@ highlight_language = 'cpp' read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - subprocess.call('cd ../; doxygen', shell=True) + subprocess.call('cd ../; doxygen; mkdir -p source/_static; cp -r doxyhtml source/_static/', shell=True) diff --git a/Docs/source/developers/developers.rst b/Docs/source/developers/developers.rst index 4eab0102a..777c2f77b 100644 --- a/Docs/source/developers/developers.rst +++ b/Docs/source/developers/developers.rst @@ -5,6 +5,8 @@ Developers documentation For general information on how to contribute to WarpX, including our ``git`` workflow and code practices, have a look at our `CONTRIBUTING.md <https://github.com/ECP-WarpX/WarpX/blob/dev/CONTRIBUTING.md>`__! +Our Doxygen API documentation in classic formatting `is located here <../_static/doxyhtml/index.html>`_. + .. toctree:: :maxdepth: 1 diff --git a/Docs/source/developers/documentation.rst b/Docs/source/developers/documentation.rst index a6f06c7bd..45ff4cd46 100644 --- a/Docs/source/developers/documentation.rst +++ b/Docs/source/developers/documentation.rst @@ -35,6 +35,8 @@ Doxygen reads this docstring, so please be accurate with the syntax! See `Doxyge */ void my_class::my_function(int* my_int); +A HTML rendered version of the Doxygen documentation `is located here <../_static/doxyhtml/index.html>`_. + Breathe documentation --------------------- |