... | @@ -24,15 +24,14 @@ When you save your changes version, GitHub automatically creates a fork (if it d |
... | @@ -24,15 +24,14 @@ When you save your changes version, GitHub automatically creates a fork (if it d |
|
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. 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. 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. Log into ReadTheDocs and add the `vN.m-latest` branch to the build list.
|
|
1. Update `vN.m-latest` with all necessary documentation changes for the new release; in particular
|
|
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.
|
|
* Document all new features.
|
|
* Document all new features.
|
|
* Note: The `master` branch will always be the one to keep up-to-date, being visible at docs.mathjax.org/en/latest.
|
|
* Note: The `master` branch will always be the one to keep up-to-date, being visible at docs.mathjax.org/en/latest.
|
|
1. Log into ReadTheDocs and add the `vN.m-latest` branch to the build list.
|
|
1. When everythingis finished, make a pull request to merge `vN.m-latest` back into `master`.
|
|
1. Merge `vN.m-latest` back into `master`.
|
|
1. Check if docs.mathjax.org has successfully built `vN.m-latest` and `master` at docs.mathjax.org
|
|
1. Push `vN.m-latest` and `master` back to github. `git push origin master vN.m-latest`
|
|
|
|
1. Check if docs.mathjax.org has the new build for `vN.m-latest`
|
|
|
|
|
|
|
|
### Appendix: Understanding the process
|
|
### Appendix: Understanding the process
|
|
|
|
|
... | | ... | |