Repository navigation
Add docsite - #225
Merged
Merged
Add docsite#225
Conversation
`docs/` now holds Markdown files that will be published to a docsite generated by `mkdocs` and hosted on GitHub Pages. Using `mkdocs` allows us to try out literate programming. This requires Python, so that's been added to the `setup` script. Thanks to some new GitHub actions, provided there have been any changes to the docs, a preview version of the docsite will be automatically published when a pull request is updated (in which case the URL will be `https://mcmire.github.io/super_diff/branches/<branch-name>/<commit.id>`), and a release version will be published when a release PR is merged (in which case it will be `https://mcmire.github.io/super_diff/releases/<version>`). Any preview version that have been previously been created for a pull request will be deleted when that pull request is closed. The CONTRIBUTING and ARCHITECTURE docs have been moved into `docs/` and expanded to not only explain how SuperDiff works but also the RSpec integration.
|
📖 A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/45fbf3ea290ace897da059d6f7b27fefd3f60167 |
|
📖 A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/f799d89172c1b0a3626216d2267ac5cee517e015 |
|
📖 A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/bdbe233d9fe4739c33fcabe697d6a0c008b0a358 |
|
📖 A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/add-docsite |
|
📖 A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/f99e890292b78a35bb5e2491e5577e187005d0a3 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/now holds Markdown files that will be published to a docsite generated bymkdocsand hosted on GitHub Pages. Usingmkdocsallows us to try out literate programming. This requires Python, so that's been added to thesetupscript.Thanks to some new GitHub actions, provided there have been any changes to the docs, a preview version of the docsite will be automatically published when a pull request is updated (in which case the URL will be
https://mcmire.github.io/super_diff/branches/<branch-name>/<commit.id>), and a release version will be published when a release PR is merged (in which case it will behttps://mcmire.github.io/super_diff/releases/<version>). Any preview version that have been previously been created for a pull request will be deleted when that pull request is closed.The CONTRIBUTING and ARCHITECTURE docs have been moved into
docs/and expanded to not only explain how SuperDiff works but also the RSpec integration.