You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DevelopersGuide.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,12 +74,21 @@ Creating an update of the documentation can therefore be quite involved (dependi
74
74
- If everything is fine, first commit all changes that were made in the main repo:
75
75
-`git add .`
76
76
-`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/`
77
80
- 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`
79
86
80
87
#### Contribute updates back to main repository
81
88
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).
0 commit comments