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

More sphinx builders #2487

Open
2 of 5 tasks
LecrisUT opened this issue Nov 20, 2023 · 1 comment
Open
2 of 5 tasks

More sphinx builders #2487

LecrisUT opened this issue Nov 20, 2023 · 1 comment

Comments

@LecrisUT
Copy link
Contributor

LecrisUT commented Nov 20, 2023

This is a continuation of #2483 to discuss and track the other sphinx builders to add

  • html: Already fully functional. Simplify the documentation building #2483 tracks the warnings as fatal errors
  • linkcheck: In Add sphinx-builder linkcheck #2489
  • man: Needs some consolidations on the hatch-scripts/makefile
  • spellcheck: This is a difficult one, because PyEnchant does not seem to support full-word dictionaries, e.g. omni-present needs to be added as omni in the dictionary file. This builder needs more research if there are alternatives (original contributor switched to skyspell) (Omitted for now until a good alternative is found. codespell is helping a bit)
  • doctest + shtest: Requires converting the rst files to the corresponding directives. No usage for doctest found so far
@LecrisUT
Copy link
Contributor Author

For the spellcheck it seems @happz finds it usable in the current state, so I will deffer the implementation to them. I thought it didn't handle capitalization that well, e.g. CMake, but maybe there is a way of writing appropriate PyEnchant dictionary files for those. I would love to see that.

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

No branches or pull requests

1 participant