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

Migrate documentation to Quarto #712

Merged
merged 14 commits into from
Aug 26, 2023
Merged

Conversation

tomicapretto
Copy link
Collaborator

@tomicapretto tomicapretto commented Aug 26, 2023

  • We don't use Sphinx anymore
  • We use quartodoc which uses griffe to extract signatures.
  • I attempted to add a PR preview feature, but it was not possible, see comment below.

With this new PR our docs page looks so much better, we don't have the formatting issues with the HTML versions of the pandas data frames, and there's a new example gallery, among other changes.

@tomicapretto
Copy link
Collaborator Author

tomicapretto commented Aug 26, 2023

I tried to add deploy previews but it doesn't work from forks. See:

rossjrw/pr-preview-action#48 (reply in thread)

edit it looks like it will be supported directly by the deploy pages action. actions/deploy-pages#180

@tomicapretto tomicapretto marked this pull request as ready for review August 26, 2023 14:06
@tomicapretto tomicapretto merged commit ae00f26 into bambinos:main Aug 26, 2023
1 of 4 checks passed
@zwelitunyiswa
Copy link

Looks really nice! @tomicapretto

GStechschulte pushed a commit to GStechschulte/bambi that referenced this pull request Oct 3, 2023
@tomicapretto tomicapretto deleted the quarto_docs branch October 26, 2023 21:11
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.

None yet

2 participants