Commit aa819c5a authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

[doc] Fix typos/add titles

parent 90aa4741
...@@ -26,7 +26,7 @@ Solutions ...@@ -26,7 +26,7 @@ Solutions
Display, compare, and query a model Display, compare, and query a model
=================================== ===================================
.. automodule:: cadbiom_cmd.solution_repr .. automodule:: cadbiom_cmd.models
:members: :members:
Merge Minimal Accessibility Conditions Merge Minimal Accessibility Conditions
......
...@@ -29,6 +29,7 @@ Setup the local copy of the code ...@@ -29,6 +29,7 @@ Setup the local copy of the code
- origin, which refers to your personal fork - origin, which refers to your personal fork
.. new line .. new line
| 2. Develop your contribution: | 2. Develop your contribution:
Pull the latest changes from upstream: Pull the latest changes from upstream:
...@@ -50,6 +51,7 @@ Setup the local copy of the code ...@@ -50,6 +51,7 @@ Setup the local copy of the code
**Cover your code with unit tests and run them before submitting your contribution.** **Cover your code with unit tests and run them before submitting your contribution.**
.. new line .. new line
| 3. Submit your contribution: | 3. Submit your contribution:
Push your changes to your fork: Push your changes to your fork:
...@@ -70,7 +72,7 @@ Once you’ve cloned your fork of the Cadbiom repository, you should set up a Py ...@@ -70,7 +72,7 @@ Once you’ve cloned your fork of the Cadbiom repository, you should set up a Py
See the chapter `Setting up a virtual environment <./installation.html#setting-up-a-virtual-environment>`_ of the installation process. See the chapter `Setting up a virtual environment <./installation.html#setting-up-a-virtual-environment>`_ of the installation process.
Then see the chapter `Setting up a virtual environment <./installation.html#install-the-development-version>`_. Then see the chapter `Install the development version <./installation.html#install-the-development-version>`_.
Bugs Bugs
......
...@@ -37,7 +37,7 @@ Technical documentation ...@@ -37,7 +37,7 @@ Technical documentation
======================= =======================
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 5
command_line_doc command_line_doc
gui_doc gui_doc
......
...@@ -52,7 +52,7 @@ Documentation ...@@ -52,7 +52,7 @@ Documentation
------------- -------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 6
installation installation
command_line_usage command_line_usage
......
...@@ -11,24 +11,46 @@ Global settings ...@@ -11,24 +11,46 @@ Global settings
Dynamical analysis Dynamical analysis
================== ==================
Dynamic system
--------------
.. automodule:: cadbiom.models.clause_constraints.CLDynSys .. automodule:: cadbiom.models.clause_constraints.CLDynSys
:members: :members:
Unfolding and solving engine
----------------------------
.. automodule:: cadbiom.models.clause_constraints.mcl.CLUnfolder .. automodule:: cadbiom.models.clause_constraints.mcl.CLUnfolder
:members: :members:
Dynamic analysis
----------------
.. automodule:: cadbiom.models.clause_constraints.mcl.MCLAnalyser .. automodule:: cadbiom.models.clause_constraints.mcl.MCLAnalyser
:members: :members:
Query
-----
.. automodule:: cadbiom.models.clause_constraints.mcl.MCLQuery .. automodule:: cadbiom.models.clause_constraints.mcl.MCLQuery
:members: :members:
Solutions representation
------------------------
.. automodule:: cadbiom.models.clause_constraints.mcl.MCLSolutions .. automodule:: cadbiom.models.clause_constraints.mcl.MCLSolutions
:members: :members:
Tests Tests
----- -----
CLUnfolder
~~~~~~~~~~
.. automodule:: cadbiom.models.clause_constraints.mcl.TestCLUnfolder .. automodule:: cadbiom.models.clause_constraints.mcl.TestCLUnfolder
:members: :members:
MCLAnalyser
~~~~~~~~~~~
.. automodule:: cadbiom.models.clause_constraints.mcl.TestMCLAnalyser .. automodule:: cadbiom.models.clause_constraints.mcl.TestMCLAnalyser
:members: :members:
MCLTranslators
~~~~~~~~~~~~~~
.. automodule:: cadbiom.models.clause_constraints.mcl.TestMCLTranslators .. automodule:: cadbiom.models.clause_constraints.mcl.TestMCLTranslators
:members: :members:
...@@ -46,16 +68,26 @@ Chart model ...@@ -46,16 +68,26 @@ Chart model
Translators Translators
----------- -----------
BCX models
~~~~~~~~~~
.. automodule:: cadbiom.models.guard_transitions.translators.chart_xml .. automodule:: cadbiom.models.guard_transitions.translators.chart_xml
:members: :members:
PID models
~~~~~~~~~~
.. automodule:: cadbiom.models.guard_transitions.translators.chart_xml_pid .. automodule:: cadbiom.models.guard_transitions.translators.chart_xml_pid
:members: :members:
Analyser Analyser
-------- --------
Static analysis
~~~~~~~~~~~~~~~
.. automodule:: cadbiom.models.guard_transitions.analyser.static_analysis .. automodule:: cadbiom.models.guard_transitions.analyser.static_analysis
:members: :members:
Visitors of guarded transitions models
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cadbiom.models.guard_transitions.analyser.ana_visitors .. automodule:: cadbiom.models.guard_transitions.analyser.ana_visitors
:members: :members:
...@@ -72,7 +104,12 @@ Simulator ...@@ -72,7 +104,12 @@ Simulator
Tests Tests
----- -----
PathExtractor
~~~~~~~~~~~~~
.. automodule:: cadbiom.models.guard_transitions.TestModelExtraction .. automodule:: cadbiom.models.guard_transitions.TestModelExtraction
:members: :members:
Static analysis
~~~~~~~~~~~~~~~
.. automodule:: cadbiom.models.guard_transitions.analyser.TestStaticAnalysis .. automodule:: cadbiom.models.guard_transitions.analyser.TestStaticAnalysis
:members: :members:
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