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

Generate documentation #223

Merged
merged 16 commits into from
Feb 11, 2022
Merged

Generate documentation #223

merged 16 commits into from
Feb 11, 2022

Conversation

Shillaker
Copy link
Collaborator

@Shillaker Shillaker commented Feb 8, 2022

Changes:

  • Add Doxygen doc generation for C++ code
  • Integrate with Sphinx using Breathe
  • Add full docs generation to Github Actions build

Docs are published at https://faabric.readthedocs.io/en/latest/

Note that the RTD build runs on the RTD servers, so the wrapper used in the GHA build is just to make sure it doesn't error, it doesn't actually produce the final result.

@Shillaker Shillaker changed the title Documentation Generate documentation Feb 8, 2022
@Shillaker Shillaker marked this pull request as draft February 10, 2022 09:53
@Shillaker Shillaker marked this pull request as ready for review February 11, 2022 10:19
- name: "TEMP - install python deps"
run: pip install -r requirements.txt
- name: "Build docs"
run: inv docs
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll remove these TEMP steps when we do the next release.

@Shillaker Shillaker merged commit c913bad into master Feb 11, 2022
@Shillaker Shillaker deleted the doxy branch February 11, 2022 10:55
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