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

Investigate moving to plain Sphinx+Breathe docs workflow #2457

Open
bryevdv opened this issue Sep 25, 2024 · 0 comments
Open

Investigate moving to plain Sphinx+Breathe docs workflow #2457

bryevdv opened this issue Sep 25, 2024 · 0 comments

Comments

@bryevdv
Copy link
Contributor

bryevdv commented Sep 25, 2024

Current repo_docs output generates cramped function signatures that are difficult to read:

Image

There is a configuration option that can potentially fix this, but fortunately, the old "public" version of repo_docs does not support it. Newer versions of repo_docs purportedly can generate better output with argument-per-line and syntax highlighting, but newer version of repo_docs are not available to use in public CI workflows. Accordingly, it may be desirable to move to a "plain" Sphinx+Breathe workflow, without repo_docs.

There are some potential issues here as well:

  • Stock Breathe may not handle templates/concepts used in the codebase. Investigating possible custom patches used in repo_docs)
  • Need to figure out if Breath auto-indexing features can be used to reduce boilerplate .rst file contents
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant