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

make doc fixups to address CI issues #869

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

bpkroth
Copy link
Contributor

@bpkroth bpkroth commented Oct 9, 2024

Pull Request

Title

Documentation generation fixups to address recent CI issues.


Description

  • Apply black and pylint to the sphinx conf.py
  • Treat sphinx warnings as errors
  • Reorg doc generation using autoapi to handle cross referencing warnings and drop use of sphinx-apidoc and autodoc
  • Update overview.rst TO follow suite
  • Update mlos_bench.run help usage

Type of Change

  • 🛠️ Bug fix
  • 📝 Documentation update
  • 🧪 Tests

Testing

  • Passes CI

@bpkroth bpkroth added WIP Work in progress - do not merge yet bug Something isn't working documentation Improvements or additions to documentation ci labels Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci documentation Improvements or additions to documentation WIP Work in progress - do not merge yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant