search

deephaven / deephaven-plugins

Deephaven Plugins
5 stars 12 forks source link

docs: function autodocs embedded in docs #527

Closed jnumainville closed 4 weeks ago

jnumainville commented 1 month ago

Fixes #501

No github action in this pr, but this allows a local build of docs as a starting point

directions to test - from README.md in plotly-express folder

Docs can be built locally from the plotle-express folder

Install the necessary dependencies:

pip install -r requirements.txt
pip install ../dist/deephaven_plugin_plotly_express-*.whl

then run the docs make script:

python make_docs.py
dsmmcken commented 1 month ago

Can we not scatter additional files in the docs folder? Those files aren't docs.

mofojed commented 1 month ago

Getting an error when trying to run locally:

Building markdown
Running Sphinx v7.2.6
1 compiler directives added
# Starting io.deephaven.python.server.EmbeddedServer
deephaven.cacheDir=/home/bender/.cache/deephaven
deephaven.configDir=/home/bender/.config/deephaven
deephaven.dataDir=/home/bender/.local/share/deephaven
# io.deephaven.internal.log.LoggerFactoryServiceLoaderImpl: searching for 'io.deephaven.internal.log.LoggerFactory'...
# io.deephaven.internal.log.LoggerFactoryServiceLoaderImpl: found 'io.deephaven.internal.log.LoggerFactorySlf4j'
Server started on port 10075

Extension error:
Could not import extension sphinx_autodoc_typehints (exception: No module named 'sphinx_autodoc_typehints')
make: *** [Makefile:20: markdown] Error 2
Copying assets
cp: cannot create directory 'docs/build/markdown/_assets': No such file or directory
cp: cannot create regular file 'docs/build/markdown/sidebar.json': No such file or directory
rm: cannot remove 'docs/build/markdown/index.md': No such file or directory