docs: function autodocs embedded in docs #527
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can we not scatter additional files in the docs folder? Those files aren't docs. |
dsmmcken
reviewed
Jun 6, 2024
| @@ -0,0 +1,6 @@ | |||
|
|
|||
There was a problem hiding this comment.
Sphinx complains if documents are not in a toctree for some reason
|
Getting an error when trying to run locally: |
mofojed
requested changes
Jun 7, 2024
| python make_docs.py | ||
| ``` | ||
|
|
||
| Note that these built files should not be committed to the repository. |
There was a problem hiding this comment.
Where do the built files get outputted? Should include that info here.
I'm getting an error right now when building 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
There was a problem hiding this comment.
Not sure why... double checked and works for me. Are you using 3.8? Looks like sphinx_autodoc_typehints will require 3.9. Should be fine since we only need it for building the docs.
There was a problem hiding this comment.
Weird, I just tried again and all good. For ref I'm on python 3.10.12
mofojed
approved these changes
Jun 12, 2024
dsmmcken
approved these changes
Jun 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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-*.whlthen run the docs make script: