Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Be sure to rebuild the generated documentation with the proper version string #244

Open
axch opened this issue Oct 8, 2015 · 5 comments
Assignees
Milestone

Comments

@axch
Copy link
Contributor

axch commented Oct 8, 2015

ditto bdbcontrib.

I believe there are two non-automatic things about this now:

  • Updating the reference manual's idea of the current version
  • Actually rerunning the documentation build and uploading it to the canonical documentation location
@axch axch added this to the R5 milestone Oct 8, 2015
@riastradh-probcomp
Copy link
Contributor

What properties characterize the resolution you would hope to attain for this bug?

The reference manual's version should be bumped only when we actually know it documents the newer version -- it is intentional that the build does not automatically grab bayeslite/VERSION or anything.

Automating publication of the documentation sounds like it is a subproblem of automatic how we publish everything -- and we don't have a single process in place for that at the moment. Did you have anything more specific in mind about that concerning documentation?

@axch
Copy link
Contributor Author

axch commented Oct 8, 2015

I suppose there are three things I want, which may plausibly deserve to be different bugs:

  • Ensure that the reference manual published with R5 both documents the R5 software and claims to.
  • Define an automatic release process that includes automatic publication of reference documentation
  • Satisfy ourselves about the processes (automatic or manual) whereby we maintain the freshness of our reference documentation.

@riastradh-probcomp
Copy link
Contributor

I updated the version in doc/conf.py for 0.1.3.

@riastradh-probcomp
Copy link
Contributor

commit 257856d

@gregory-marton
Copy link
Contributor

@raxraxraxraxrax, you may want to review and recommend changes for the documentation for 0.1.4, taking into account whatever does actually happen for polish, and I guess keeping in mind the question of how in particular satellite enthusiasts might interact with it, if at all. It would be good to have some part of the release process checklist that includes such a review for the future, rather than relying on a bug?

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

No branches or pull requests

4 participants