Project - Documentation

This article is deals with projects related to improving GNU Octave's documentation. For general project ideas, see Projects.

News

• GNU Octave applies for the Google Season of Docs (GSoD) 2020. Potential participation will be announced on May 11, 2020 at 12:00 UTC. Discuss about your ideas and application with us by using Octave's
  • maintainers@octave.org mailing list (please bottom post!)
  • #octave IRC channel in Freenode

Existing Documentation

For a comprehensive list see Publications about Octave.

• Doxygen documentation for the C++ classes.

• Texinfo documentation for the Octave interpreter.

• This wiki:
  • FAQ
  • Resources: Tutorials, Examples, Tips and Tricks, ...

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.