@@ -22,13 +22,12 @@ The documentation comprises:
22
22
* Python API documentation of Python generated via SWIG (doxygen-style comments
23
23
translated to docstrings by SWIG)
24
24
* C++ API documentation (doxygen -> exhale -> breathe -> sphinx)
25
- * Matlab API documentation (mtocpp -> doxygen -> exhale -> breathe -> sphinx)
26
25
27
26
### Doxygen-only (legacy)
28
27
29
28
(Parts of the) AMICI documentation can also be directly created using
30
29
[ doxygen] ( http://www.doxygen.nl/ ) directly. It combines Markdown files from
31
- ` doc/ ` and in-source documentation from the C++ and Matlab source files.
30
+ ` doc/ ` and in-source documentation from the C++ source files.
32
31
33
32
The documentation is generated by running
34
33
@@ -40,15 +39,8 @@ The resulting HTML and PDF documentation will be created in
40
39
41
40
#### Doxygen configuration
42
41
43
- The main doxygen configuration file is located in
44
- ` matlab/mtoc/config/Doxyfile.template ` . Edit this file for inclusion or
45
- exclusion of additional files.
46
-
47
- #### Matlab documentation
48
-
49
- Matlab documentation is processed by
50
- [ mtoc++] ( https://www.morepas.org/software/mtocpp/docs/tools.html ) .
51
- This is configured in ` matlab/mtoc/config ` .
42
+ The main doxygen configuration file is located in ` doc/Doxyfile.template ` .
43
+ Edit this file for inclusion or exclusion of additional files.
52
44
53
45
## Writing documentation
54
46
@@ -62,13 +54,13 @@ Graphics for documentation are kept in `doc/gfx/`.
62
54
### When using Markdown
63
55
64
56
* Note that there are some incompatibilities of GitHub Markdown and Doxygen
65
- Markdown. Ideally documentation should be written in a format compatible with
57
+ Markdown. Ideally, documentation should be written in a format compatible with
66
58
both.
67
- This affects for example images links which currently cause trouble in
59
+ This affects, for example, image links which currently cause trouble in
68
60
Doxygen.
69
61
70
62
* Where possible, relative links are preferred over absolute links. However,
71
- they should work with both Github and Doxygen and ideally with local files
63
+ they should work with both GitHub and Doxygen and ideally with local files
72
64
for offline use.
73
65
74
66
* Please stick to the limit of 80 characters per line for readability of raw
0 commit comments