You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

59 lines
2.2 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License AGPL-3
  4. =================================================================================================
  5. This module generates the Technical Guides of selected modules in Restructured Text format (RST).
  6. =================================================================================================
  7. Originally developed by OpenERP SA, migrated from the OpenERP version 6.1 to Odoo version 8.0
  8. by the Odoo Community Association.
  9. * It uses the Sphinx (http://sphinx.pocoo.org) implementation of RST
  10. * It creates a tarball (.tgz file suffix) containing an index file and one file per module
  11. * Generates Relationship Graph
  12. It performs its actions only on the modules that are actually installed in the same database
  13. (being available in the module list is not enough).
  14. Installation
  15. ============
  16. * The module automatically takes care of its dependencies and is ready for use after the installation
  17. TODO
  18. =======
  19. * Hide "Relationship Graph" page if module not installed.
  20. * Raise an exception when clicking on "Generate Relationship..." if the module is not installed.
  21. Credits
  22. =======
  23. Contributors
  24. ------------
  25. * OpenERP SA <http://www.odoo.com>
  26. * Matjaž Mozetič <m.mozetic@matmoz.si>
  27. Bug Tracker
  28. ===========
  29. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  30. In case of trouble, please check there if your issue has already been reported.
  31. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  32. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20base_module_doc_rst%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  33. Maintainer
  34. ----------
  35. .. image:: https://odoo-community.org/logo.png
  36. :alt: Odoo Community Association
  37. :target: https://odoo-community.org
  38. This module is maintained by the OCA.
  39. OCA, or the Odoo Community Association, is a nonprofit organization whose
  40. mission is to support the collaborative development of Odoo features and
  41. promote its widespread use.
  42. To contribute to this module, please visit http://odoo-community.org.