Project - Documentation

From Octave
Revision as of 17:59, 17 April 2020 by Siko1056 (talk | contribs) (→‎Projects: First draft for suggested projects.)
Jump to navigation Jump to search
This article is deals with projects related to improving GNU Octave's documentation. For general project ideas, see Projects.

News

SeasonofDocs Logo SecondaryGrey 300ppi.png

Existing Documentation

For a comprehensive list see Publications about Octave.
  • Doxygen documentation for the C++ classes.

Suggested Projects

Octave's interpreter documentation

The documentation for the interpreter is presumably the oldest, long grown documentation of the GNU Octave project. It would be useful to have lots more examples, to not have so many forward references, and to not have very many simple lists of functions.

Add more demo files.

  • Source code
https://hg.savannah.gnu.org/hgweb/octave/file/tip/doc/interpreter
  • Required skills
Texinfo, hg, building Octave from source
  • Potential mentors
Kai


Octave's internal documentation

Add more Doxygen comments.


Octave's wiki

Flesh out this wiki.