Commit 06bcba27 authored by BorjaEst's avatar BorjaEst
Browse files

Added apidoc at user_guide

parent 3f28b67e
......@@ -20,7 +20,7 @@ Documentation
* How to use the o3skim :doc:`getting_started/cli`
.. toctree::
:maxdepth: 1
:maxdepth: 2
:hidden:
:caption: Getting started
......@@ -33,15 +33,15 @@ Documentation
**User guide**
* Create your :doc:`user_guide/source-file` to point what to skim.
* Learn how to skim by reading the :doc:`user_guide/API-reference`
* Learn how to skim by reading the :doc:`user_guide/o3skim`
.. toctree::
:maxdepth: 1
:maxdepth: 2
:hidden:
:caption: User guide:
user_guide/source-file
user_guide/API-reference
user_guide/o3skim
**Developer guide**
......@@ -50,7 +50,7 @@ Documentation
* How to run and create new :doc:`dev_guide/tests`
.. toctree::
:maxdepth: 1
:maxdepth: 2
:hidden:
:caption: Developer guide:
......
API-reference
==================================
\ No newline at end of file
o3skim package
==============
Submodules
----------
o3skim.sources module
---------------------
.. automodule:: o3skim.sources
:members:
:undoc-members:
:show-inheritance:
o3skim.utils module
-------------------
.. automodule:: o3skim.utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: o3skim
:members:
:undoc-members:
:show-inheritance:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment