Skip to content
Snippets Groups Projects
Commit 0eed45f1 authored by Jan Caron's avatar Jan Caron
Browse files

Test removing api from docs

parent bfe01c64
No related branches found
No related tags found
No related merge requests found
......@@ -40,7 +40,7 @@ test_docs:
# -o: Directory to place the output files. If it does not exist, it is created.
# last parameter: module path
- python setup.py clean # TODO: Simplest way to generate version.py without doing anything else?
- sphinx-apidoc -f -e -o docs/api src/empyre
#- sphinx-apidoc -f -e -o docs/api src/empyre
# Build the documentation from 'docs' and put into 'build/sphinx':
- sphinx-build docs build/sphinx
artifacts:
......
empyre.fields package
=====================
Submodules
----------
empyre.fields.field module
--------------------------
.. automodule:: empyre.fields.field
:members:
:undoc-members:
:show-inheritance:
empyre.fields.shapes module
---------------------------
.. automodule:: empyre.fields.shapes
:members:
:undoc-members:
:show-inheritance:
empyre.fields.vectors module
----------------------------
.. automodule:: empyre.fields.vectors
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: empyre.fields
:members:
:undoc-members:
:show-inheritance:
empyre.io package
=================
Module contents
---------------
.. automodule:: empyre.io
:members:
:undoc-members:
:show-inheritance:
empyre.models package
=====================
Module contents
---------------
.. automodule:: empyre.models
:members:
:undoc-members:
:show-inheritance:
empyre.reconstruct package
==========================
Module contents
---------------
.. automodule:: empyre.reconstruct
:members:
:undoc-members:
:show-inheritance:
empyre package
==============
Subpackages
-----------
.. toctree::
empyre.fields
empyre.io
empyre.models
empyre.reconstruct
empyre.vis
Submodules
----------
empyre.version module
---------------------
.. automodule:: empyre.version
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: empyre
:members:
:undoc-members:
:show-inheritance:
empyre.vis package
==================
Submodules
----------
empyre.vis.colors module
------------------------
.. automodule:: empyre.vis.colors
:members:
:undoc-members:
:show-inheritance:
empyre.vis.decorators module
----------------------------
.. automodule:: empyre.vis.decorators
:members:
:undoc-members:
:show-inheritance:
empyre.vis.plot2d module
------------------------
.. automodule:: empyre.vis.plot2d
:members:
:undoc-members:
:show-inheritance:
empyre.vis.tools module
-----------------------
.. automodule:: empyre.vis.tools
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: empyre.vis
:members:
:undoc-members:
:show-inheritance:
empyre
======
.. toctree::
:maxdepth: 4
empyre
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment