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

Allow user packages in 'make doc' #5950

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mtorpey
Copy link
Contributor

@mtorpey mtorpey commented Mar 5, 2025

make doc fails if there is no installation of GAPDoc in gap/pkg/ because it runs with the -r flag that disables user package directories.

This PR removes the -r flag so that user-installed GAPDoc and other packages can be used in compiling the doc.

This is the last link required for users to be able to do a complete install using only PackageManager and no other packages.

(I have some déjà vu with this – apologies if we've talked about this before and I've forgotten.)

Copy link
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me, but it would be good if e.g. @ThomasBreuer and @frankluebeck also had a quick look / think about this.

@fingolfin fingolfin added topic: documentation Issues and PRs related to documentation release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes labels Mar 10, 2025
@ThomasBreuer
Copy link
Contributor

I had added the -r flag in #5835.
My point was that calling make_doc is intended to run w.r.t. the currently distributed GAP packages, and the user specific root directory likely provides newer package versions. (For example, my directory contains the development version of GAPDoc.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants