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.

Sign up for GitHub

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

Jump to bottom

Use autodoc to generate the documentation #550

Open
james-d-mitchell opened this issue Jun 27, 2022 · 1 comment
Open

Use autodoc to generate the documentation #550

james-d-mitchell opened this issue Jun 27, 2022 · 1 comment
Labels
doc Issues, bugs, pull requests relating to the documentation technical A necessary technical change, not interesting mathematically/feature-wise

Comments

@james-d-mitchell
Copy link
Member

In Semigroups v4.0.0, we started using autodoc to produce the documentation, this has a number of advantages, and can be used with the current documentation sources (i.e. doesn't require to re-write the manual completely). I was prompted to make this issue by @mtorpey's comment on #549, about where to add author's names, if we convert to using autodoc, then we will only have to put the author's in a single place.
@james-d-mitchell james-d-mitchell added doc Issues, bugs, pull requests relating to the documentation technical A necessary technical change, not interesting mathematically/feature-wise labels Jun 27, 2022
@github-actions
Copy link

Stale issue message

@james-d-mitchell james-d-mitchell mentioned this issue Aug 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues, bugs, pull requests relating to the documentation technical A necessary technical change, not interesting mathematically/feature-wise
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@james-d-mitchell