Skip to content

Moving docs into master and automatic deployment #436

@H0R5E

Description

@H0R5E

This issue is to demonstrate the concept of storing documentation in master (and any branches off master), in the docs folder, and using TravisCI to build and deploy the docs to the gh-pages branch. I have set up an example of this process in this repository. The associated docs (built by TravisCI) can be found here.

There are a few extra goodies here also, as follows:

  1. By using sphinxext-remoteliteralinclude I was able to remove the need for the WEC-Sim Applications repo to be cloned for the docs to compile. The example code is now read from Github.com, directly.
  2. I have used sphinxcontrib-versioning to build the docs for both the master and the dev branches. This allows docs updates to be submitted against dev which can act as a "staging" area, before merging into master.
  3. I have added a folder structure to the .rst files, so that they are kept in their own folder called man, which makes the sphinx system a little easier to navigate.

@kmruehl, if this is something you would like to implement, then can I request that we stop adding to the gh-pages branch. I have to manually merge changes between the two systems to keep them up to date.

These are the steps for closing this out:

  • Merge PR Add online documentation to docs folder #439 into master and then check local build
  • Merge master into dev and then check local build on dev
  • Clean up README in gh-pages branch.
  • Add travisCI configuration to master and attempt automatic build
  • Merge travisCI configuration into dev and attempt automatic build
  • Remove WEC-Sim_Applications submodules (or just one of them)?

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions