Skip to content

Homogenize the doc #261

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

Merged
merged 6 commits into from
Jun 11, 2025
Merged

Conversation

Joseph-Edwards
Copy link
Collaborator

@Joseph-Edwards Joseph-Edwards commented Jun 9, 2025

This PR addresses some inconsistencies within in the doc. Specifically:

  • The "Elements" section now has the same structure as the rest of the doc;
  • Class pages all follow the same structure.
  • All functions now appear in autosummaries

@Joseph-Edwards
Copy link
Collaborator Author

This PR will likely be the first of several doc-related PRs, rather than having a big behemoth.

@Joseph-Edwards
Copy link
Collaborator Author

The class pages in data-structees/ now have the same structure, with a few exceptions like matrix where we write everything in the .rst file rather than the doc in the .cpp file.

@james-d-mitchell
Copy link
Member

@Joseph-Edwards it's probably better if we merge smaller chunks rather than bigger ones, so I'd be happy enough to merge this, and have the remaining check boxes as separate PRs, if that's ok with you?

Add missing reporter functions

Add missing runner functions

Remove libsemigroups. from signatures

Add missing presentation functions

Add ukkonen missing functions

Add AhoCorasick missing functions

Add Dot missing functions

Add Gabow missing functions

Restructure word-graph doc

Add Joiner missing functions

Add missing words functions
Add missing Action functions to summary

Add missing Congruence functions to summary

Add missing FroidurePin functions to summary

Add missing Kambites functions to summary

Add missing KnuthBendix functions to summary

Add missing Konieczny functions to summary

Add missing Sims functions to summary

Add missing SchreierSims functions to summary

Add missing Stephen functions to summary

Add missing ToddCoxeter functions to summary
@Joseph-Edwards Joseph-Edwards marked this pull request as ready for review June 11, 2025 17:05
@james-d-mitchell james-d-mitchell merged commit b4aae24 into libsemigroups:v1 Jun 11, 2025
11 checks passed
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