Giter VIP home page Giter VIP logo

odoo-sphinx-autodoc's Introduction

===================
Odoo Sphinx Autodoc
===================

This package provides a sphinx extension that allows to use "openerp.addons.*" with sphinx autodoc feature.

Options
=======

- sphinxodoo_addons : List of addons name to load (if empty, no addon will be loaded)
- sphinxodoo_root_path : Path of the Odoo root directory
- sphinxodoo_addons_path : List of paths were Odoo addons to load are located

odoo-sphinx-autodoc's People

Contributors

elicoidal avatar guewen avatar gurneyalex avatar yvaucher avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

odoo-sphinx-autodoc's Issues

[IMP] Documentation itself is a little simple.

Hello.

Can you set a little step by step in the readme about how to use this extension.

I am an sphinx user but always a little confused about how prepare my environment with external dependencies like this one.

Regards.

State of this repository

Hi,

I want to know what is the actual state of this repository.

It have 2 good PR still open.

And all works are a little old.

For what I want to know?

To build documentation module with sphinx and odoo, but not for autodoc python code.

I'll want to build sphinx documentation content and render generated HTML on Odoo web module.

How are you about it ?

Thanks.

transfer ownership to OCA

Hello @sylvain-garancher

As discussed during the code sprint, we would like to setup this project under the OCA umbrella if this is OK with you.

Fails if non module directories are present in ODOO_ADDONS_PATH directory (exemple with setup folder)

https://travis-ci.org/OCA/geospatial/jobs/124475258

For exemple with the setup folder introduced in repositories for packaging:

Exception occurred:
  File "/home/travis/virtualenv/python2.7_with_system_site_packages/local/lib/python2.7/site-packages/sphinxodoo/ext/autodoc.py", line 27, in load_odoo_modules
    module_name, openerp.tools.config['addons_path'].split(','))
ImportError: No module named setup

Odoo 10

The namespace has been changed from openerp to odoo. It should then be able to import the correct namespace.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.