1,855
edits
Project - Documentation: Difference between revisions
Jump to navigation
Jump to search
→Octave's interpreter documentation: Add more content.
m (Improve summary.) |
(→Octave's interpreter documentation: Add more content.) |
||
| Line 33: | Line 33: | ||
* Check for inconsistencies in the manual, e.g., outdated descriptions, awkwardly ordered information, ... | * Check for inconsistencies in the manual, e.g., outdated descriptions, awkwardly ordered information, ... | ||
* More examples and demo files for using each Octave command. | * More examples and demo files for using each Octave command. | ||
* More figures to demonstrate Octave's plotting capabilities. | * More figures to demonstrate Octave's plotting capabilities, but regard doc size and building time. | ||
* | * Think about a superior organization/splitting of the manual. Currently it covers many topics interleaved: user manual, function reference, developer guide. | ||
** Idea for a function reference including [[Octave Forge]] packages: https://octave.sourceforge.io/docs.php (unmaintained) | |||
* Document the documentation building process (e.g. rename and document involved scripts). | |||
'''Long term goals / highly controversial within the community''' | |||
* Syntax, structure, and readability of Texinfo is a burden for some developers and newcomers. Consider replacement by | |||
** [https://commonmark.org/ CommonMark/Markdown] | |||
** [https://docutils.readthedocs.io/en/sphinx-docs/user/rst/quickstart.html reStructuredText] / [https://www.sphinx-doc.org/ Sphinx] | |||
** ... | |||
'''Resources''' | '''Resources''' | ||
| Line 46: | Line 55: | ||
* '''Potential mentors''' | * '''Potential mentors''' | ||
: [[User:siko1056 | Kai]] | : [[User:siko1056 | Kai]] | ||
=== Octave's internal documentation === | === Octave's internal documentation === | ||