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

Add docs infra #215

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Add docs infra #215

merged 1 commit into from
Oct 23, 2024

Conversation

benjeffery
Copy link
Member

Fixes #209

After thinking about it jupyter-book made the most sense as we use it on other projects and it is there if the docs grow.
I think pages in the site could link here rather than trying to fit docs in the app itself.

Any image URL in the markdown that looks like tsbrowse:file.tsbrowse:page_name gets rendered automatically. In this way screenshots in the docs are kept up to date. Filed #214 for completion of content.

Copy link

Automated Screenshots

These screenshots are automatically updated as the PR changes.

Click to view screenshots

edges.png

edges.png

mutations-popup.png

mutations-popup.png

mutations.png

mutations.png

nodes.png

nodes.png

out_edges.png

out_edges.png

out_mutations.png

out_mutations.png

out_nodes.png

out_nodes.png

overview.png

overview.png

tables.png

tables.png

trees.png

trees.png

github-actions bot pushed a commit that referenced this pull request Oct 23, 2024
github-actions bot pushed a commit that referenced this pull request Oct 23, 2024
github-actions bot pushed a commit that referenced this pull request Oct 23, 2024
@coveralls
Copy link

coveralls commented Oct 23, 2024

Pull Request Test Coverage Report for Build 11484917745

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 90.288%

Totals Coverage Status
Change from base Build 11478549132: 0.0%
Covered Lines: 753
Relevant Lines: 834

💛 - Coveralls

Copy link
Member

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

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

Snazzy!

@benjeffery benjeffery merged commit b319c7c into tskit-dev:main Oct 23, 2024
6 checks passed
@benjeffery benjeffery deleted the docs branch October 23, 2024 19:40
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.

Documentation site/page
3 participants