Skip to content
Snippets Groups Projects
Commit 54a1cba9 authored by Hervé  MENAGER's avatar Hervé MENAGER
Browse files

improvements on documentation

- "database" section including the schema
- "about" included in API docs
parent 10a67dd1
No related branches found
No related tags found
No related merge requests found
Pipeline #15863 passed
How to update and build the documentation for iPPI-DB
=====================================================
- update the database graphical representation
python ../manage.py graph_models ippidb --pygraphviz --output source/db.dot
- build the docs
make html
The main page of the documentation is in build/html/index.html.
...@@ -50,6 +50,7 @@ extensions = [ ...@@ -50,6 +50,7 @@ extensions = [
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.graphviz'
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
......
iPPI-DB database
================
.. graphviz:: db.dot
This diff is collapsed.
...@@ -3,14 +3,20 @@ ...@@ -3,14 +3,20 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to iPPI-DB's documentation! Welcome to the iPPI-DB technical documentation!
=================================== ===============================================
iPPI-DB is an online database of modulators of protein-protein interactions.
The database itself and its description are hosted at https://ippidb.pasteur.fr.
These pages contain the documentation for technical maintenance and development purposes.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
install install
database
modules modules
......
IPPIDB Python API reference iPPI-DB Python API reference
=========================== ============================
.. automodule:: ippidb .. automodule:: ippidb
:members: :members:
......
...@@ -4,6 +4,7 @@ iPPI-DB views ...@@ -4,6 +4,7 @@ iPPI-DB views
.. autosummary:: .. autosummary::
:toctree: _autosummary :toctree: _autosummary
about
contribute contribute
compound_query compound_query
""" """
......
...@@ -158,7 +158,7 @@ STATIC_ROOT = os.path.join(BASE_DIR, 'static_root') ...@@ -158,7 +158,7 @@ STATIC_ROOT = os.path.join(BASE_DIR, 'static_root')
#$ ./manage.py graph_models -a > db.dot #$ ./manage.py graph_models -a > db.dot
#$ dot db.dot -T png -odb.png #$ dot db.dot -T png -odb.png
GRAPH_MODELS = { GRAPH_MODELS = {
'all_applications': True, 'all_applications': False,
'group_models': True, 'group_models': True,
} }
......
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