docs: update for Documenter 1.x, surface missing docstrings, add POMDPs.jl page#60
Open
jamgochiana wants to merge 4 commits into
Open
docs: update for Documenter 1.x, surface missing docstrings, add POMDPs.jl page#60jamgochiana wants to merge 4 commits into
jamgochiana wants to merge 4 commits into
Conversation
a3d554f to
3d7473a
Compare
5a3399d to
0c70816
Compare
- Replace 'format = :html' with 'format = Documenter.HTML()' — the Symbol-based format API was Documenter 0.x and is unsupported in Documenter 1.x (raises 'Cannot convert Symbol to Documenter.Writer'). - Add 'warnonly = [:docs_block, :missing_docs]' so existing duplicate-docs / missing-docs issues in the .md sources surface as warnings instead of build-blocking errors. Cleaning up those individual doc-source issues is out of scope here. Verified locally with: julia --project=docs docs/make.jl
…e links Resolve the docs-build issues that were previously masked by warnonly: Surface 6 previously-undocumented symbols whose docstrings existed in src/ but were not referenced from any .md page: - AbstractFilter, DynamicsModel, ObservationModel (now in kalman.md intro / 'Building a Filter') - unscented_transform, unscented_transform_inverse (kalman.md UKF area) - MvNormalPDF (gmphd.md utilities) Disambiguate duplicate @docs blocks. The bare GaussianFilters.update / predict / measure references appeared on both kalman.md and gmphd.md, each pulling in every method of those generics and producing duplicate entries. Replace with method-signature-qualified references on each page so kalman.md documents the Kalman-class methods and gmphd.md documents the PHDFilter methods. Update the 'Examples' sections on both pages to point at examples/*.jl instead of the removed notebooks/*.ipynb (carryover fix from #49). docs/Project.toml: add GaussianFilters as a dep with a [sources] path entry so the docs build against the in-tree source (previously docs relied on the registered version being available). Remove the warnonly band-aid added earlier in this layer — the build now passes cleanly with no missing_docs or docs_block errors.
Surface the new pomdps_updater function added in the previous layer and add the two POMDPs-related examples (pomdps_integration, pendulum_ekf_ilqr) to the kalman.md examples list. Keeps the docs build clean (no missing_docs warnings).
Move the POMDPs section out of kalman.md and into a new top-level Integrations -> POMDPs.jl Integration page (docs/src/pomdps.md). Add a quick-start code snippet showing the three-step pomdps_updater usage and document the direct-dispatch path for callers that don't need the full POMDPs.simulate machinery. Also document the initialize_belief-from-MvNormal pattern with a small example. Add a new 'Integrations' section to the pages tree in make.jl. kalman.md now contains only a one-line cross-reference to the new page.
0c70816 to
f020372
Compare
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.
Four commits that bring the documentation up to date:
build(docs): update Documenter API for 1.x compat— replacesformat = :html(Documenter 0.x) withformat = Documenter.HTML()(Documenter 1.x). The:htmlform raisesCannot convert Symbol to Documenter.Writerunder current Documenter.docs: surface missing docstrings, resolve duplicate @docs, fix example links— surfaces 6 previously-undocumented public symbols (AbstractFilter,DynamicsModel,ObservationModel,unscented_transform,unscented_transform_inverse,MvNormalPDF) by adding them to the appropriate@docsblocks. Disambiguates duplicate@docsreferences (the bareGaussianFilters.update/predict/measurereferences on bothkalman.mdandgmphd.mdwere pulling in every method and producing duplicate entries — now method-signature-qualified per page). Updates Example links fromnotebooks/*.ipynbtoexamples/*.jl.docs/Project.tomlgains a[sources]path entry so docs build against the in-tree source.docs(kalman): document pomdps_updater and link POMDPs.jl examples— initial integration mention inkalman.md(later moved out by the next commit).docs: promote POMDPs.jl integration to its own page— moves the POMDPs content out ofkalman.mdinto a newdocs/src/pomdps.mdunder a newIntegrationssection. Adds a quick-start code snippet, documents direct dispatch vs thepomdps_updaterwrapper, and shows initializing a belief from anMvNormal.Verified locally — docs build cleanly with no
missing_docsordocs_blockerrors.