docs(api): thematic API reference generated from coverage manifest - #856
Open
ocots wants to merge 2 commits into
Open
docs(api): thematic API reference generated from coverage manifest#856ocots wants to merge 2 commits into
ocots wants to merge 2 commits into
Conversation
Make the documentation buildable again, archive the pre-v2.1 pages,
and land the final capability-first skeleton so the remaining
content PRs do not touch the build environment.
- realign docs/Project.toml with the root [compat]
- add CTLie, DifferentiationInterface, ForwardDiff, OrdinaryDiffEqTsit5
- fix docs/make.jl: defensive extension loading, InterLinks, sitemap, Literate
- archive old docs/src/*.md and api/{public,subpackages}.md to docs/attic/
- create stub pages for the new sitemap
- track docs/src/assets/Manifest.toml and Project.toml for reproducibility
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
- Replace the hand-maintained api/public.md with theme pages generated from docs/reports/99-api-coverage.md at build time. - Add missing/stale coverage checks against names(OptimalControl) so the reference cannot drift from the code again. - Rename the old Private page to Internals and keep describe.jl in it. - Rewrite api/ecosystem.md with the seven control-toolbox packages, including the missing CTLie link. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
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
1 participant
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.
Summary
api/public.md(now indocs/attic/) with thematic API-reference pages generated at build time.docs/api_reference.jlnow parses the contract indocs/reports/99-api-coverage.md, builds aAPI_THEMESmanifest, and writes one page per theme (modelling,problem,solving,options,solution,flows,geometry,types,io,qualified,internals).qualified. The build fails witherroron drift.Privatepage toInternals(per the Handbook wording) and keepsdescribe.jlin it.docs/src/api/ecosystem.mdto list the seven control-toolbox packages with@extreflinks, including the missingCTLie.makedocsand removed afterward by the existing_cleanup_pagesmechanism, so onlyecosystem.mdremains tracked.Test plan
julia --project=docs docs/make.jlcompletes withexit 0.docs/src/api/contains onlyecosystem.mdafter the build.Ecosystem.names(OptimalControl)and compare with the generated pages).Notes
This branch is based on
docs/infrastructure(PR 2) because the page skeleton with the final@idanchors is not yet onmain. It should be rebased/retargeted tomainonce PR 2 is merged.Generated with Devin