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

Proof-of-concept doc command #26

Closed
wants to merge 2 commits into from
Closed

Conversation

stefanv
Copy link
Member

@stefanv stefanv commented Nov 29, 2022

Questions to resolve:

  • Should we ensure that the correct requirements are installed beforehand? If so, how?
  • Should we make SPHINXOPTS customizable? (Current is -W)
  • Should we cater for directories other than doc (e.g., docs)?

@stefanv stefanv force-pushed the main branch 2 times, most recently from 128a2c1 to 3121ec2 Compare January 12, 2023 01:30
@ganesh-k13 ganesh-k13 mentioned this pull request Feb 25, 2023
2 tasks
Comment on lines +37 to +38
print("$ export SPHINXOPTS='-W'")
os.environ["SPHINXOPTS"] = "-W"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think an option to override these could be useful. While iterating locally it can be useful to disable the -W flag, complete the build and clean up all the warnings afterwards. Otherwise the build fails on the first warning without showing the other ones.

@jarrodmillman
Copy link
Member

See #78 and #79.

@stefanv stefanv closed this Jul 1, 2023
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.

3 participants