Skip to content

Add API Reference documentation as Github pages #173

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

Merged
merged 9 commits into from
Aug 19, 2024

Conversation

rdelillo
Copy link
Contributor

@rdelillo rdelillo commented Aug 13, 2024

Changelog Description

Addresses #21

  • Implemented sphinx autodoc as ci workflow
  • Few docstring edits to remove sphinx errors
  • Sphinx configuration polishes

Result here : https://ynput.github.io/ayon-python-api/build/html/ (temporary url)

Additional info

Potential follow-up issues not covered by this PR:

@rdelillo rdelillo added documentation Improvements or additions to documentation type: enhancement New feature or request labels Aug 13, 2024
@rdelillo rdelillo linked an issue Aug 13, 2024 that may be closed by this pull request
@rdelillo rdelillo changed the title Documentation/21 add sphinx api reference Add API Reference documentation as Github pages Aug 13, 2024
@rdelillo
Copy link
Contributor Author

rdelillo commented Aug 13, 2024

@jakubjezek001 I could reproduce but couldn't find any fix regarding the style hiccup you mentioned.
gif_anim_capture

This definitely comes from the theme CSS .

  • -webkit-font-smoothing: antialiased!important;
  • font-size: 1rem;

It could be related to the page content being quite long to format... anyway, this is very inconsistent.
If that's an issue, I can probably inject a custom CSS sheet to prevent this.

@rdelillo rdelillo self-assigned this Aug 14, 2024
@rdelillo rdelillo requested a review from iLLiCiTiT August 19, 2024 15:07
@iLLiCiTiT iLLiCiTiT merged commit 19479f4 into develop Aug 19, 2024
1 check passed
@iLLiCiTiT iLLiCiTiT deleted the documentation/21-add-sphinx-api-reference branch August 19, 2024 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generated HTML api docs through sphinx and upload them as Github pages
2 participants