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

Documentation/CI fixes #2783

Merged
merged 8 commits into from
Jun 5, 2024
Merged

Conversation

mikee47
Copy link
Contributor

@mikee47 mikee47 commented May 31, 2024

This PR contains a few minor fixes relating to CI testing and documentation. There are no functional changes to the framework.

Documentation fixes

  • Noticed that :issue: links don't work! Just a typo in the URL...
  • The Storage component API documentation contained everything from the FatIFS and DiskStorage libraries
    too since they live in the same namespace. I've broken things out a bit to avoid that.
  • Doxygen API index page isn't appearing at https://sming.readthedocs.io/en/latest/api/, just the placeholder page. The pages are all there but Sphinx hasn't overwritten the placeholder index.html as it should do. Fixed by adding a manual copy at end of sphinx build. Tested on readthedocs and locally.
  • Document STRICT setting and add upgrade note about Y2038 warning.
  • Add tips to vscode documentation.
  • Upgrade sphinx to latest 7.3.7

Test fixes

  • Simplify HostTests partition layout
  • Fix uf2conf python regex warning

@mikee47 mikee47 force-pushed the feature/ci-doc-updates branch 2 times, most recently from 8e7dd62 to 8035aca Compare June 1, 2024 13:56
@mikee47 mikee47 changed the title [WIP] CI testing / documentation fixes CI testing / documentation fixes Jun 1, 2024
@mikee47 mikee47 force-pushed the feature/ci-doc-updates branch from 6073bb3 to 3ba4848 Compare June 2, 2024 13:54
@mikee47 mikee47 changed the title CI testing / documentation fixes Documentation/CI fixes Jun 2, 2024
@SmingHub SmingHub deleted a comment from what-the-diff bot Jun 2, 2024
@mikee47 mikee47 force-pushed the feature/ci-doc-updates branch from f08fed4 to 1b1cb9c Compare June 2, 2024 21:12
@slaff slaff added this to the 5.2.0 milestone Jun 3, 2024
@slaff
Copy link
Contributor

slaff commented Jun 3, 2024

@mikee47 can you rebase this PR?

@mikee47 mikee47 force-pushed the feature/ci-doc-updates branch from 1b1cb9c to c9fcaa6 Compare June 3, 2024 09:50
@slaff slaff removed the 3 - Review label Jun 5, 2024
@slaff slaff merged commit 90511f1 into SmingHub:develop Jun 5, 2024
38 checks passed
@mikee47 mikee47 deleted the feature/ci-doc-updates branch June 7, 2024 14:28
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.

2 participants