Skip to content

Conversation

@pp-mo
Copy link
Member

@pp-mo pp-mo commented Sep 12, 2019

Closes #3396

NOTE: I have made version changes (2.2 --> 2.3) to the .RSTs in 3 places :

  • docs/iris/src/_templates/index.html
  • docs/iris/src/_templates/layout.html
  • docs/iris/src/whatsnew/index.rst

In future, to make this scheme work properly (so branch docs are properly readable, especially the whats-new), we really need to move these on just after a new release, when we bump the version in master.
That is, exactly as we do to the iris version string.

@pp-mo
Copy link
Member Author

pp-mo commented Sep 12, 2019

Working as-is (at last!).
Resulting docs here : https://scitools-docs.github.io/iris/auto_branch_docs/index.html

-- it's there because this source branch is in SciTools/iris, not in my fork as usual.
( So, we need to delete that later... )

@pp-mo pp-mo added this to the v2.3.0 milestone Sep 12, 2019
Copy link
Member

@lbdreyer lbdreyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @pp-mo!

It will be great to get the auto docs building back!
I have just a few comments ...

@pp-mo
Copy link
Member Author

pp-mo commented Sep 16, 2019

Thanks @lbdreyer , I hope I've addressed those points now.
Mostly : I have added a 'special' mode to the aggregation as suggested, and it produces a temporary whatsnew page with a temporary non-version name.
See : https://scitools-docs.github.io/iris/auto_branch_docs/whatsnew/index.html

@lbdreyer
Copy link
Member

Looking good! Thanks @pp-mo !

@lbdreyer lbdreyer merged commit ec46449 into master Sep 16, 2019
@pp-mo pp-mo deleted the auto_branch_docs branch September 16, 2019 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Auto build of docs for each branch

3 participants