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.

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

Script to generate API documentation #139

Merged
merged 7 commits into from
Jun 29, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyblock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyblock module
====================================

.. automodule:: easybuild.framework.easyblock
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.constants.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.constants module
===============================================

.. automodule:: easybuild.framework.easyconfig.constants
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.default.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.default module
=============================================

.. automodule:: easybuild.framework.easyconfig.default
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.easyconfig.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.easyconfig module
================================================

.. automodule:: easybuild.framework.easyconfig.easyconfig
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.convert.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.convert module
====================================================

.. automodule:: easybuild.framework.easyconfig.format.convert
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.format module
===================================================

.. automodule:: easybuild.framework.easyconfig.format.format
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.one.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.one module
================================================

.. automodule:: easybuild.framework.easyconfig.format.one
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.pyheaderconfigobj module
==============================================================

.. automodule:: easybuild.framework.easyconfig.format.pyheaderconfigobj
:members:
:undoc-members:
:show-inheritance:
23 changes: 23 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
easybuild.framework.easyconfig.format package
=============================================

Submodules
----------

.. toctree::

easybuild.framework.easyconfig.format.convert
easybuild.framework.easyconfig.format.format
easybuild.framework.easyconfig.format.one
easybuild.framework.easyconfig.format.pyheaderconfigobj
easybuild.framework.easyconfig.format.two
easybuild.framework.easyconfig.format.version
easybuild.framework.easyconfig.format.yeb

Module contents
---------------

.. automodule:: easybuild.framework.easyconfig.format
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.two.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.two module
================================================

.. automodule:: easybuild.framework.easyconfig.format.two
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.version module
====================================================

.. automodule:: easybuild.framework.easyconfig.format.version
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.format.yeb.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.format.yeb module
================================================

.. automodule:: easybuild.framework.easyconfig.format.yeb
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.licenses.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.licenses module
==============================================

.. automodule:: easybuild.framework.easyconfig.licenses
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.parser.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.parser module
============================================

.. automodule:: easybuild.framework.easyconfig.parser
:members:
:undoc-members:
:show-inheritance:
32 changes: 32 additions & 0 deletions docs/api/easybuild.framework.easyconfig.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
easybuild.framework.easyconfig package
======================================

Subpackages
-----------

.. toctree::

easybuild.framework.easyconfig.format

Submodules
----------

.. toctree::

easybuild.framework.easyconfig.constants
easybuild.framework.easyconfig.default
easybuild.framework.easyconfig.easyconfig
easybuild.framework.easyconfig.licenses
easybuild.framework.easyconfig.parser
easybuild.framework.easyconfig.templates
easybuild.framework.easyconfig.tools
easybuild.framework.easyconfig.tweak
easybuild.framework.easyconfig.types

Module contents
---------------

.. automodule:: easybuild.framework.easyconfig
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.templates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.templates module
===============================================

.. automodule:: easybuild.framework.easyconfig.templates
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.tools module
===========================================

.. automodule:: easybuild.framework.easyconfig.tools
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.tweak.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.tweak module
===========================================

.. automodule:: easybuild.framework.easyconfig.tweak
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.easyconfig.types.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.easyconfig.types module
===========================================

.. automodule:: easybuild.framework.easyconfig.types
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.extension.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.extension module
====================================

.. automodule:: easybuild.framework.extension
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.framework.extensioneasyblock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.framework.extensioneasyblock module
=============================================

.. automodule:: easybuild.framework.extensioneasyblock
:members:
:undoc-members:
:show-inheritance:
26 changes: 26 additions & 0 deletions docs/api/easybuild.framework.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
easybuild.framework package
===========================

Subpackages
-----------

.. toctree::

easybuild.framework.easyconfig

Submodules
----------

.. toctree::

easybuild.framework.easyblock
easybuild.framework.extension
easybuild.framework.extensioneasyblock

Module contents
---------------

.. automodule:: easybuild.framework
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.main.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.main module
=====================

.. automodule:: easybuild.main
:members:
:undoc-members:
:show-inheritance:
26 changes: 26 additions & 0 deletions docs/api/easybuild.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
easybuild package
=================

Subpackages
-----------

.. toctree::

easybuild.framework
easybuild.toolchains
easybuild.tools

Submodules
----------

.. toctree::

easybuild.main

Module contents
---------------

.. automodule:: easybuild
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.cgmpich.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.cgmpich module
===================================

.. automodule:: easybuild.toolchains.cgmpich
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.cgmpolf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.cgmpolf module
===================================

.. automodule:: easybuild.toolchains.cgmpolf
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.cgmvapich2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.cgmvapich2 module
======================================

.. automodule:: easybuild.toolchains.cgmvapich2
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.cgmvolf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.cgmvolf module
===================================

.. automodule:: easybuild.toolchains.cgmvolf
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.cgompi.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.cgompi module
==================================

.. automodule:: easybuild.toolchains.cgompi
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.cgoolf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.cgoolf module
==================================

.. automodule:: easybuild.toolchains.cgoolf
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.clanggcc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.clanggcc module
====================================

.. automodule:: easybuild.toolchains.clanggcc
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.clang.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.clang module
==========================================

.. automodule:: easybuild.toolchains.compiler.clang
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.craype.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.craype module
===========================================

.. automodule:: easybuild.toolchains.compiler.craype
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.cuda.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.cuda module
=========================================

.. automodule:: easybuild.toolchains.compiler.cuda
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.dummycompiler.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.dummycompiler module
==================================================

.. automodule:: easybuild.toolchains.compiler.dummycompiler
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.gcc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.gcc module
========================================

.. automodule:: easybuild.toolchains.compiler.gcc
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.ibmxl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.ibmxl module
==========================================

.. automodule:: easybuild.toolchains.compiler.ibmxl
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.inteliccifort.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.inteliccifort module
==================================================

.. automodule:: easybuild.toolchains.compiler.inteliccifort
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/easybuild.toolchains.compiler.pgi.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
easybuild.toolchains.compiler.pgi module
========================================

.. automodule:: easybuild.toolchains.compiler.pgi
:members:
:undoc-members:
:show-inheritance:
Loading