Add recommended configuration of Sphinx build options
PipKat opened this issue · 1 comments
PipKat commented
📝 Description of the feature
@dnwillia-work thought it would be good to have the recommended configuration for Sphinx build options in the PyAnsys Developer's Guide. He said that Fluent's build options are here: pyfluent/Makefile at main · pyansys/pyfluent (github.com)
He then said that they use -W and that most repos should probably be using that.
💡 Steps for implementing the feature
No response
🔗 Useful links and references
Fluent's Sphinx build options are here: pyfluent/Makefile at main · pyansys/pyfluent (github.com)
dnwillia-work commented
Thanks Kathy. Yes, in particular I think -W --keep-going is useful. This way you get all the warnings in the build log so you can inspect the log, fix everything and updated the PR.