Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adjust docs/make.jl to changes in Documenter.jl #945

Merged
merged 2 commits into from
Oct 27, 2023

Conversation

ThomasBreuer
Copy link
Member

Now we can almost process the documentation with Documenter.jl 1.0.

  • The creation of hyperlinks to the GAP documentation works again.
  • The errors because of docstrings that are not referenced in docs/src/*.md are gone because the docstrings are now referenced. (I do not like this at all. Why is it an error not to include all available docstrings?)
  • There are still errors because three explicit cross-references to the JuliaInterface manual (in the directory assets/html/JuliaInterface) are not accepted because they are local links outside the build directory.

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

Merging #945 (e336b58) into master (3cfb342) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #945   +/-   ##
=======================================
  Coverage   75.70%   75.70%           
=======================================
  Files          51       51           
  Lines        4169     4169           
=======================================
  Hits         3156     3156           
  Misses       1013     1013           

@fingolfin
Copy link
Member

You can also add checkdocs = :none to the arguments of makedocs to stop it from throwing an error when a docstring does not appear in the manual.

Alternatively one can set warnonly = true -- this is actually what we had before (warnonly replaces the former option strict which defaulted to false -- so in a sense they just toggled the default value...). The drawback is that warnonly = true will also treat other things as only warnings, were we really might want to get an error, so we notice it and can fix it....

docs/src/other.md Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
Now we can *almost* process the documentation with Documenter.jl 1.0.

- The creation of hyperlinks to the GAP documentation works again.
- The errors because of docstrings that are not referenced in `docs/src/*.md`
  are gone because the docstrings are now referenced.
  (I do not like this at all.
  Why is it an error not to include all available docstrings?)
- There are still errors because three explicit cross-references to the
  JuliaInterface manual (in the directory `assets/html/JuliaInterface`)
  are not accepted because they are local links outside the build
  directory.
@ThomasBreuer ThomasBreuer force-pushed the TB_adjust_to_documenter branch from 0bf3bff to e336b58 Compare October 15, 2023 21:37
@fingolfin
Copy link
Member

Oops, I kinda forgot about this PR.

Everything looks good, tests pass -- is there any reason not to merge it?

@fingolfin
Copy link
Member

Oh wait, now I understand: the three errors you are referring to are for when one switches to actually using Documenter.jl 1.x -- which this PR does not, it just prepares for this.

@fingolfin fingolfin merged commit fd56d6b into oscar-system:master Oct 27, 2023
@ThomasBreuer ThomasBreuer deleted the TB_adjust_to_documenter branch November 2, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants