This repository has been archived by the owner on Mar 11, 2022. It is now read-only.
Add setup for building and publishing docs #35
Merged
Conversation
This file contains 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
|
@pvlugter thanks for putting this together and give a starting point for language support docs. 👍 |
This was referenced Jun 3, 2020
GratefulTony
pushed a commit
to GratefulTony/python-support
that referenced
this pull request
Sep 15, 2020
Add setup for building and publishing docs
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Since there are no docs yet, I thought the python support could be a good place to start with separate module docs for cloudstateio/cloudstate#104.
This adds an sbt project for building and publishing docs, which uses the same setup and theme as for the main cloudstate documentation.
The docs are basically empty — just showing the properties for version (automatically based on git tags) and an extref created for cloudstate core docs.
This is set up for publishing docs automatically from travis — updated for multi-language build (which should work, let's confirm). The snapshot version should be published automatically once this PR is merged (and the PR should check the regular tests are still configured correctly).
Docs will be published to https://cloudstate.io/docs/python/current/ (and
/{version}) on releases, and to https://cloudstate.io/docs/python/snapshot/ on doc changes to master.Once actual docs are added, we can retro-publish for the current version (0.1.0), and we can add to the doc home page here: https://cloudstate.io/docs/