Skip to content

Commit c01e1da

Browse files
committed
Updated Developers Guide with info on documentation update
1 parent d5550d9 commit c01e1da

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

DevelopersGuide.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,21 @@ Creating an update of the documentation can therefore be quite involved (dependi
7474
- If everything is fine, first commit all changes that were made in the main repo:
7575
- `git add .`
7676
- `git commit -m "update message"`
77+
- Copy updated documentation to a temporary directory,for example `/tmp/docs-html` with:
78+
- `mkdir /tmp/docs-html`
79+
- `cp -R docs/build/html/* /tmp/docs-html/`
7780
- checkout the documentation branch: `git checkout gh-pages`
78-
81+
- Copy the updated files into the main folder of the `gh-pages` branch: `cp -R /tmp/docs-html/* .`
82+
- To be sure: check updated documentation, open `index.html`, now in the main folder of the repository.
83+
- Commit all changes:
84+
- `git add .`
85+
- `git commit -m "Updated documentation in gh-pages branch`
7986

8087
#### Contribute updates back to main repository
8188

82-
89+
- Push _both_ branches `main` and `gh-pages` back to your own remote GitHub profile
90+
- Create a pull request for both branches (make sure to create the pull request for the `gh-pages` branch also to the `gh-pages` branch of the original gempy repository)
91+
- Please include meaningful descriptions about your changes (both, in the main repo, as well as in the documnetation).
8392

8493

8594

0 commit comments

Comments
 (0)