Skip to content

Commit 2274043

Browse files
committed
Remove unnecessary instructions on general GitHub usage
1 parent 87564c2 commit 2274043

File tree

4 files changed

+3
-16
lines changed

4 files changed

+3
-16
lines changed

docs/04_developer_guide/developer_guide.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
The section addresses developers of Tianshou, providing information for
44
both casual contributors and maintainers alike.
55

6+
67
## Python Virtual Environment
78

89
Tianshou is built and managed by [poetry](https://python-poetry.org/).
@@ -101,21 +102,6 @@ If incompatibilities should arise (e.g. by the "py_latest" test failing), we eit
101102
* add an upper bound to our dependency declarations (excluding the incompatible versions) and release a new
102103
version of Tianshou to make these exclusions explicit.
103104

104-
#### Instructions for Users New to GitHub
105-
106-
1. Click the `Actions` button in your own repo:
107-
108-
![Actions button](../_static/images/action1.jpg)
109-
110-
2. Click the green button:
111-
112-
![Enable actions](../_static/images/action2.jpg)
113-
114-
3. You will see `Actions Enabled.` on the top of html page.
115-
116-
4. When you push a new commit to your own repo (e.g. `git push`), it will automatically run the test in this page:
117-
118-
![Actions running](../_static/images/action3.png)
119105

120106
## Documentation
121107

@@ -140,6 +126,7 @@ We have several automated verification methods for documentation:
140126

141127
3. sphinx spelling and test: test if there is any error/warning when generating front-end html documentation.
142128

129+
143130
## Creating a Release
144131

145132
To release a new version on PyPI,
@@ -149,4 +136,4 @@ To release a new version on PyPI,
149136
* push the commit (`git push`) and the tag (`git push --tags`)
150137
* create a new release on GitHub based on the tag; this will trigger the release job for PyPI.
151138

152-
In the past, we provided releases to conda-forge as well,
139+
In the past, we provided releases to conda-forge as well, but this is currently not maintained.

docs/_static/images/action1.jpg

-55.7 KB
Binary file not shown.

docs/_static/images/action2.jpg

-39.7 KB
Binary file not shown.

docs/_static/images/action3.png

-11 KB
Binary file not shown.

0 commit comments

Comments
 (0)