Embed the CalculusWithJuliaSquared API as a docs section - #5
Merged
Conversation
`Calculus` @reexports `CalculusWithJuliaSquared`, so its docstrings are loaded in the docs build. Surface them as a native reference section rather than sending readers to a separate site. - make.jl: add CWJS to `modules`; `using Calculus.CalculusWithJuliaSquared` so the autodocs block resolves; `warnonly = Documenter.except(:autodocs_block)` to keep Calculus's own content strict while tolerating the CWJS block; `remotes` pointing CWJS source links at the fork's main branch (its installed tree has no .git). The page is a top-level entry, not a generic "API" section, so it doesn't read as Calculus's own API. - docs/src/API/CalculusWithJuliaSquared.md: separate-package + reexport framing, links to the original notes / our fork / the forthcoming rendered book, then `@autodocs`. - index.md: an intro section on the port and the reexport pointing at the API page. Only CWJS's own functions are pulled (`lim`, `tangent`, `D`, `riemann`, …), not the reexported Symbolics/Plots. Builds clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.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.
Surfaces the
CalculusWithJuliaSquared(CWJS) package's API as a native section of this site.Why it works across separate repos
Calculus@reexports CWJS, so the package's module — and all its docstrings — are loaded in the docs build. Documenter builds API docs from docstrings of loaded modules, so no cross-repo HTML is involved; it reads docstrings out of the installed package.Changes
docs/make.jlusing Calculus.CalculusWithJuliaSquaredso the@autodocsblock resolves the module name.modules = [Calculus, CalculusWithJuliaSquared].warnonly = Documenter.except(:autodocs_block)— keeps Calculus's own content strictly checked, relaxing only the embedded CWJS block (mirrors CWJS's ownmake.jl).remotespointing CWJS docstrings' "source" links atFourMInfo/CalculusWithJuliaSquared.jlonmain— the installed package tree has no.git, so Documenter can't otherwise infer a remote (it hard-errorsMissingRemoteError).docs/src/API/CalculusWithJuliaSquared.md— separate-package +@reexportframing; links to the original notes (live), our fork's source (GitHub), and the rendered book (forthcoming atfourm.info/cwjsn); then@autodocs Modules = [CalculusWithJuliaSquared].docs/src/index.md— an intro section on the port and the reexport, pointing readers at the API page.Scope check
Only CWJS's own functions are pulled (
lim,tangent,secant,D,riemann,∇, …) — not the reexported Symbolics/Plots.typosclean;docs/make.jlbuilds green.Independent of the derivatives-chapter work on
content/edit-derivatives.🤖 Generated with Claude Code