search

tpaviot / pythonocc-documentation

Documentation for the pythonocc 3D CAD python package
30 stars 23 forks source link

Missing indexes #1

Open nopria opened 4 years ago

nopria commented 4 years ago

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/.

jediyoda36 commented 3 years ago

Same problem here, did anyone solved it?

MarcSallent commented 3 years ago

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

hebmay commented 3 years ago

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.

ts0ron commented 2 years ago

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

aboudev commented 2 years ago

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__)