OCA / odoorpc

Python module to pilot your Odoo servers through JSON-RPC.
http://pythonhosted.org/OdooRPC/
GNU Lesser General Public License v3.0
231 stars 123 forks source link

Documentation cannot be built #98

Open madduck opened 1 month ago

madduck commented 1 month ago

The documentation cannot be built according to the README:

lotus:…/odoo/odoorpc|master|% python setup.py build                                                 
No Sphinx module found. You have to install Sphinx to be able to generate the documentation.
running build
running build_py
lotus:…/odoo/odoorpc|master|% python
Python 3.11.9 (main, Apr 10 2024, 13:16:36) [GCC 13.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from sphinx.setup_command import BuildDoc
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'sphinx.setup_command'

lotus:…/odoo/odoorpc|master|% pip list | grep -i sphinx 
Sphinx                        7.4.5
sphinxcontrib-applehelp       1.0.8
sphinxcontrib-devhelp         1.0.6
sphinxcontrib-htmlhelp        2.0.5
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-qthelp          1.0.7
sphinxcontrib-serializinghtml 1.1.10
tfreestone-PSI commented 1 month ago

I had the same issue, the readme doesn't have great instructions for getting started as a brand new user and there's not a lot of help online. here are my steps: After installing sphinx i cd to the directory that contains my local git repo for odoorpc i use sphinx-quickstart then follow the readme instructions still no luck so i know im missing something

I did have some success using make html eg. odoorpc>make html output: Running Sphinx v8.0.2 loading translations [en]... done making output directory... done building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 28 source files that are out of date updating environment: [new config] 28 added, 0 changed, 0 removed reading sources... [100%] index tons of errors: ERROR: Unknown directive type "autoclass". Unknown directive type "automodule". Unknown directive type "doctest". .. doctest::

Product = odoo.env['product.product'] product_en = Product.browse(1) product_en.env.lang 'en_US' product_en.name = "My product" # Update the english translation looking for now-outdated files... none found pickling environment... done checking consistency... WARNING: document isn't included in any toctree done preparing documents... done copying assets... copying static files... done copying extra files... done copying assets: done writing output... [100%] index generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 16 warnings.

The HTML pages are in _build\html.