First attempt at sphinx documentation #6
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
jmalkin
requested changes
Sep 12, 2023
| with: | ||
| python-version: '3.x' | ||
| - name: Install Datasketches and Sphinx | ||
| run: python -m pip install . sphinx==7.2.4 sphinx-rtd-theme |
There was a problem hiding this comment.
with luck we'll be able to remove the pinned version, or else use the fix in the issue about this: sphinx-doc/sphinx#11662 (comment)
| ``` | ||
|
|
||
| ## Problems | ||
| The `density_sketch` and `tuple_sketch` are not yet included. |
There was a problem hiding this comment.
this seems to be an interaction with sphinx 7.2.5; 7.2.4 should work, and that's why it's pinned in the yaml.
we should probably look into including the packages in conf.py as a workaround, only because that seems like it should be mostly harmless.
add copyright year
jmalkin
approved these changes
Sep 12, 2023
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.
This should automatically build the documentation for all sketches except density and tuple.
Please see the
docs/Readme.mdfor further details.