| ... | @@ -23,11 +23,15 @@ When you save your changes version, GitHub automatically creates a fork (if it d |
... | @@ -23,11 +23,15 @@ When you save your changes version, GitHub automatically creates a fork (if it d |
|
|
1. Merge `master` into the branch `current` corresponding to the **current** version, i.e., the version that will be replaced by the new release.
|
|
1. Merge `master` into the branch `current` corresponding to the **current** version, i.e., the version that will be replaced by the new release.
|
|
|
1. Push `current` to github: `git commit -a -m "(log message about the 'current' branch)" &&
|
|
1. Push `current` to github: `git commit -a -m "(log message about the 'current' branch)" &&
|
|
|
git push origin "current"`
|
|
git push origin "current"`
|
|
|
1. Update `master` with all necessary documentation for the new release; in particular
|
|
1. Create a branch of `master` corresponding to the released version `vN.m-latest` and push it to github `git push origin vN.m-latest`.
|
|
|
|
1. Update `vN.m-latest` with all necessary documentation changes for the new release; in particular
|
|
|
* update the version number in the Sphinx configuration file `config.py`.
|
|
* update the version number in the Sphinx configuration file `config.py`.
|
|
|
* Create a "What's new"-page for the new release.
|
|
* Create a "What's new"-page for the new release.
|
|
|
* Note: The `master` branch will always be the most up-to-date, being visible at docs.mathjax.org/en/latest.
|
|
* Document all new features.
|
|
|
1. Upon release, create `vN.m-latest` branch for the new release and modify it (Note: this branch will have to be updated updated manually but will allow people to have a stable link for documentation of that version)
|
|
* Note: The `master` branch will always be the one to keep up-to-date, being visible at docs.mathjax.org/en/latest.
|
|
|
|
1. Merge `vN.m-latest` back into `master`.
|
|
|
|
1. Push `vN.m-latest` and `master` back to github. `git push origin master vN.m-latest`
|
|
|
|
1. After(!) the release, modify the `vN.m-latest` branch (Note: this branch will have to be updated updated manually but will allow people to have a stable link for documentation of that version)
|
|
|
* the edit-on-github link `_templates/sourcelink.html` to point to the `current` branch.
|
|
* the edit-on-github link `_templates/sourcelink.html` to point to the `current` branch.
|
|
|
* the theme layout `_themes/sphinx-bootstrap/layout.html`: add the version-warning to the quick-links:
|
|
* the theme layout `_themes/sphinx-bootstrap/layout.html`: add the version-warning to the quick-links:
|
|
|
* After `<li><strong>Quick links</strong></li>` insert `<li> <a class="btn btn-mini btn-success" href="http://docs.mathjax.org/">Newer version available!</a> </li>` (this may seem counter-intuitive, but `latest` is designed to be more up-to-date.
|
|
* After `<li><strong>Quick links</strong></li>` insert `<li> <a class="btn btn-mini btn-success" href="http://docs.mathjax.org/">Newer version available!</a> </li>` (this may seem counter-intuitive, but `latest` is designed to be more up-to-date.
|
| ... | | ... | |
