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

chpldoc and mason doc improvements to wire project info #26509

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

e-kayrakli
Copy link
Contributor

This PR makes several improvements for mason doc.

  • The template sphinx configuration has couple of important fields programmable via new environment variables like CHPLDOC_PROJECT_NAME
  • chpldoc now has the ability to use an existing sphinx project: a Mason package should be able to have its own conf.py + index.rst. Currently, chpldoc simply overrides it. This is exposed with --has-sphinx flag, which prevents coping the generic Chapel template.
  • mason doc passes project name into the environment variable I mentioned above.

I will probably continue on this as I find time to improve the integration a bit better.

TODO:

  • add a field to Mason.toml to pick up an existing sphinx config dir
  • make Mason generate a stub of that config dir

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.

1 participant