AbstractAlgebra.jl icon indicating copy to clipboard operation
AbstractAlgebra.jl copied to clipboard

Make building the package docs more convenient

Open fingolfin opened this issue 3 months ago • 6 comments

The sources entry in docs/Project.toml helps ensure the correct version of the package is used.

There is also now a way to override the doctest test setting, so that one can turn them off for a quick test, or enable the fix mode for updating examples.

This may need some discussion before it gets merged and rolled out to perhaps some more of our repos; I'll add some inline comments to relevant code sections

fingolfin avatar Sep 21 '25 20:09 fingolfin

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 87.93%. Comparing base (4b127f8) to head (f51792d).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2173   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files         127      127           
  Lines       31776    31776           
=======================================
  Hits        27941    27941           
  Misses       3835     3835           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Sep 21 '25 21:09 codecov[bot]

What about the Hecke.build_doc()/Oscar.build_doc() way? Just wondering what you mean when you say "rolled out to perhaps some more of our repos". Do we want two slightly different ways for the same thing?

thofma avatar Sep 22 '25 15:09 thofma

I don't like the Hecke.build_doc()/Oscar.build_doc() way -- it causes us all kinds of pain, and I think we can get the same or better with less hacks, based on what this PR does plus more.

fingolfin avatar Sep 26 '25 07:09 fingolfin

(In particular I have an extended version of this using Revise and for repeated rebuilds of the docs. I'll try to get it cleaned up and into another PR, but I think it might actually be better to do one for Hecke or Oscar first. We'll see. Might also be a good idea if @thofma @lgoettgens and me sat on a Zoom (?) call for a bit to talk about it. But we are all busy and this is hardly a priority right now...

fingolfin avatar Sep 26 '25 07:09 fingolfin

What is is "new" idea how to build the documentation? As in how and what command?

fieker avatar Sep 26 '25 07:09 fieker

Without Revise support I have a hard time imagening how doing julia docs/make.jl (which is what this PR here adivses?) is better than *.build_doc(). Can you just add the Revise support here in this PR?

thofma avatar Sep 26 '25 07:09 thofma