Skip to content
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
merged 1 commit into from
Jun 2, 2020
Merged

Add setup for building and publishing docs #35

merged 1 commit into from
Jun 2, 2020

Conversation

pvlugter
Copy link
Member

@pvlugter pvlugter commented Jun 2, 2020

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/

@marcellanz
Copy link
Contributor

@pvlugter thanks for putting this together and give a starting point for language support docs. 👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Antora Documentation for Event Sourcing
2 participants