Skip to content
This repository has been archived by the owner on Aug 11, 2023. It is now read-only.

Commit

Permalink
more documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Nov 29, 2017
1 parent 2e343c5 commit 38326ef
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
2 changes: 1 addition & 1 deletion cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"use_read_the_docs": "y",
"sphinx_theme": "astropy-boostrap",
"initialize_git_repo": "y",
"astropy_helpers_version": "v2.0",
"astropy_helpers_version": "v2.0.2",
"_parent_project": "astropy",
"_install_requires": "astropy",
"_copy_without_render": [
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ rendered the template read :ref:`next-steps`.
:caption: Contents:

options
updating
nextsteps
updating



Expand Down
12 changes: 8 additions & 4 deletions docs/updating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,28 @@ settings configured to your package and then pull the changes into your package.
to make this process easier, and possibly even automated.


1. **Render the template**: Putting in the same settings as the first time the
#. **Render the template**: Putting in the same settings as the first time the
template was rendered (or using ``--replay``) render the template to a
temporary folder::

$ cookiecutter [--replay] gh:astropy/package-template -o /tmp

2. **Make a new branch**::
#. **Make a new branch**::

$ git checkout -b update_template

3. **Copy the template over your package**: (replacing 'packagename' with your package name)::
#. **Copy the template over your package**: (replacing 'packagename' with your package name)::

$ cp -r /tmp/packagename ./

4. **Git diff the patch**::
#. **Use git diff to see the changes**::

$ git diff

#. **Edit the files** until the changes shown by `` git diff`` are the ones you want to have in your package.

#. **Merge the changes** Either by a Pull Request or by merging the ``update_template`` branch into your master branch.


Using git Update
----------------
Expand Down

0 comments on commit 38326ef

Please sign in to comment.