pythonocc-documentation icon indicating copy to clipboard operation
pythonocc-documentation copied to clipboard

Missing indexes

Open nopria opened this issue 5 years ago • 5 comments

In documentation compiled with sphinx following readme instructions there is no index whatsoever, therefore no content is linked. I noticed the same issue at https://readthedocs.org/projects/pythonocc-core/.

nopria avatar Jun 21 '20 14:06 nopria

Same problem here, did anyone solved it?

jediyoda36 avatar Oct 21 '20 02:10 jediyoda36

If you were getting ModuleNotFoundError: No module named 'sphinx_rtd_theme', I don't know how to solve it in the repository, but I could make it work locally by doing:

Create virtual environment and activate it virtualenv lc source lc/bin/activate install sphinx_rtd_theme pip install sphinx_rtd_theme compile as the readme says make html

MarcSallent avatar Jan 04 '21 11:01 MarcSallent

I have the same issue. If I run make html, I get:

WARNING: autodoc: failed to import module 'CDF' from module 'OCC'; the following exception was raised:
No module named 'OCC'

same warning for all modules.

Then I get: "WARNING: document isn't included in any toctree" for each *.rst file.

hebmay avatar Jan 18 '21 12:01 hebmay

After installing sphinx_rtd_theme I use the 'make html' as said, however most of the toolkits does not have anything shown in the index after opening in Chrome.

For example, looked for Geom2d, found it and clicked but it is empty inside. Any suggestions? did someone encounter that before ?

Thanks

ts0ron avatar Oct 18 '21 15:10 ts0ron

To compile the api doc, the following steps work for me:

cd $PYTHONOCC-DOCUMENTATION/api_doc/
rm OCC*rst
sphinx-apidoc /PATH/TO/PYTHON/OCC/PACKAGE/ -o .
make html

You can query your occ package path in python:

import OCC
print(OCC.__file__)

aboudev avatar Dec 31 '21 05:12 aboudev