Closed VikingScientist closed 6 years ago
you update the gh-pages branch.
But that would mean that one updates the master branch first, generates the documentation and then creates a pull request on the gh-pages branch.
I guess a decent work-flow would be to update the documentation pages after all version bumps.
Ready for review. With the exception of 424384b4f92dc29f7f841202b076a32d328e2e8f , then all commits only touch documentation.
Also: I am no longer a fan of our choice of html theme "haiku". It is a bit messy, but mostly unfamiliar. Documentation is a place to go to for looking stuff up, so easy navigation and familiarity should take priority over style. Thus I propose either "classic" or "numpy" since most users would find these familiar. The former is included in the list of built-in themes, while the latter requires a plugin
Regarding the double-spacing at the beginning of comments, then this started when I was looking at
def line(a, b, relative=False):
""" Create a line between two points.
:param array-like a: Start point
:param array-like b: End point
:param bool relative: Whether *b* is relative to *a*
:return: Linear curve from *a* to *b*
:rtype: Curve
"""
In which case I found zero or one space to look too crammed. The "Create a line between two points." kind of became the headline for this method and it needed some space. After forcing this on all other methods, then it seemed suboptimal on functions with very long headline descriptions, but by that time I was commited and it proved to become the new standard.
Doesn't really matter though as long as they all follow the same structure; which they did not do before.
Fair enough.
How does one update the API doc which is linked to on the front page?