Repository navigation
docs: make the documentation build complete - #365
Open
lachlangrose wants to merge 1 commit into
Open
lachlangrose wants to merge 1 commit into
lachlangrose wants to merge 1 commit into
Conversation
- fix homepage and user-guide examples that used bounding_box.structured_grid().properties (that returns the interpolation-support grid, which has no properties dict) - fix dtm_creator importing Union from ctypes, which made the module unimportable - make docs/requirements.txt install the docs extra; add trame packages to it - start gallery examples from an empty stratigraphic column so the unused Basement group no longer logs 'Model does not contain Group_N' errors - fix reST errors (toctree, code-block directives, literal blocks, title underline) - add preparing_data and structural_frames to the user guide toctree Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or 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
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.
First step of a docs/examples cleanup: make
sphinx-buildcomplete. Before this, the build crashed on the homepage and no HTML was produced.Fixes
what_is_a_geological_model.rst: the examples calledbounding_box.structured_grid().properties, but that method returns the interpolation-support grid, which has noproperties. The pyvista plot directive then raised anAssertionErrorand killed the build. The examples now buildLoopStructural.geometry.StructuredGriddirectly, as the library does internally. Also fixed the'stratí'typo and the malformed secondtoctreeon the homepage.LoopStructural/utils/dtm_creator.py: importedUnionfromctypesinstead oftyping, so the module could not be imported (and its API page failed).docs/requirements.txtnow installs the project'sdocsextra; the extra gainstrame,trame-vtkandtrame-vuetify, which the pyvista Sphinx extensions need.Basementgroup becameGroup_1and loggedModel does not contain Group_N. They now callstratigraphic_column.clear(basement=False)first (plot_2,plot_3,plot_5,4_advanced/plot_2).code-block:directives, a literal block in the contributors guide, a bullet list inabout.rst, a title underline, theCHANGELOGtoctree entry that did not resolve, and two docstrings (set_stratigraphic_column,setup_interpolator).preparing_dataandstructural_framesto the User Guide toctree (they were orphans).Result
sphinx-buildnow finishes ("build succeeded, 98 warnings") and all 20 gallery examples run. Previously it crashed.Not in this PR
loop_commonandLoopStructural).Loop3DViewdocstrings.visualisation.rst/debugging.rststill describe the removedLavaVuModelViewer;map2loop.rstis an unformatted paste.plot_7,plot_9,plot_6).plot_3andplot_4.Build notes
_staticas a file and the build then fails withNotADirectoryError. Runmkdir -p <out>/_staticbefore building. A CI job would need this.packages/*/srconPYTHONPATHin a scratch venv; I did not build from a cleanpip install .[docs].LoopStructural.geometry.StructuredGridis an alias ofPropertyGrid, so these examples keep working either way.🤖 Generated with Claude Code