Skip to content

minorisa/dochelp

Repository files navigation

Odoo Documentation Help

This module creates both a Help menu option and a Sphinxh-based documentation foundation.

Help Menu

A new Menu item is created in the top navigation menu bar. This is an URL action, opening a dochelp/index.html web page. An Odoo controller for HTML pages located under ths home page is also included.

Sphinx documentation

Help website is created using Sphinx, a standard tool that makes it easy to create intelligent and beautiful documentation, that uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

Usage

The documentation system uses the inheritance modular system from sphinxcontrib.inheritance.

This addon installs a Wizard enabling you to render the documentation. It uses 2 sources:

  • The odoo-doc repository in GitHub, containing the source files for the core modules of Odoo.
  • All rst files in the non-core installed modules that matches the pattern doc\<language>\*.rst.

The non-core files should follow the inheritance guidelines specified in the sphinxcontrib.inheritance. Yes.

Credits

Contributors

Maintainer

Minorisa, S.L.

About

DocHelp module for Odoo

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages