Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
synergy
o3skim
Commits
06bcba27
Commit
06bcba27
authored
Oct 23, 2020
by
BorjaEst
Browse files
Added apidoc at user_guide
parent
3f28b67e
Changes
3
Hide whitespace changes
Inline
Side-by-side
docs/index.rst
View file @
06bcba27
...
...
@@ -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:
...
...
docs/user_guide/API-reference.rst
deleted
100644 → 0
View file @
3f28b67e
API-reference
==================================
\ No newline at end of file
docs/user_guide/o3skim.rst
0 → 100644
View file @
06bcba27
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:
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment