Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Nils Brüggemann
pyicon
Commits
deb42472
Commit
deb42472
authored
Sep 10, 2021
by
Nils Brüggemann
Browse files
Merge branch 'master' of gitlab.dkrz.de:m300602/pyicon into master
parents
c9bc191d
18156697
Pipeline
#10616
passed with stages
in 8 seconds
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
doc/api.rst
0 → 100644
View file @
deb42472
API for pyicon
==============
::
Warning! This automatically generated documentation
is still under development!
Some semi-automatically generate documentation about the pyicon API.
.. automodule:: pyicon
pyicon.pyicon_IconData
----------------------
.. automodule:: pyicon.pyicon_IconData
:members:
pyicon.pyicon_plotting
----------------------
.. automodule:: pyicon.pyicon_plotting
:members:
doc/conf.py
View file @
deb42472
...
...
@@ -15,10 +15,11 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
#
import os
#
import sys
import
os
import
sys
# sys.path.insert(0, os.path.abspath('.'))
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'../..'
))
# Source code dir relative to this file
# -- General configuration ------------------------------------------------
...
...
@@ -34,10 +35,11 @@ extensions = [
'sphinx.ext.autodoc'
,
'sphinx.ext.todo'
,
'sphinx.ext.imgmath'
,
'nbsphinx'
,
"sphinx_copybutton"
,
"IPython.sphinxext.ipython_directive"
,
"IPython.sphinxext.ipython_console_highlighting"
,
# 'sphinx.ext.autosummary',
# 'nbsphinx',
# "sphinx_copybutton",
# "IPython.sphinxext.ipython_directive",
# "IPython.sphinxext.ipython_console_highlighting",
]
# Add any paths that contain templates here, relative to this directory.
...
...
doc/index.rst
View file @
deb42472
...
...
@@ -24,6 +24,7 @@ Pyicon is hosted here: `<https://gitlab.dkrz.de/m300602/pyicon/>`_
documentation
quickplots
view
api
Indices and tables
...
...
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