This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • Publishing Documentation Via Read The Docs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Versioning (Tags and Branches)

Producing/updating documentation for a specific 'release/branch' is different depending on whether the version is liked to a tag or branch. (it's not consistent - sorry about that it was like that when I found it).

The RTD uses the branches and tags to link versions of the documentation to moments in time in the source, to update the tags and branches seen by RTD, run a build of master

...

The reading of tags is dynamic, so you can remove and re-add a tag and then rebuild that 'version'.

Updating Branch Versions

If the versions of documentation are linked to branches (ie Installation Docs) then :

  1. *TO DO not sure if this bit is true yet* create a branch using the version as the name of the branch.
  2. Update the available tags in RTD by running a build of master.
  3. Then create a version linked to the tag that you added previously
  4. Then build that version.

Merging a pull request into that branch will cause the version to be built and updated online automatically

...