This repository was archived by the owner on Mar 13, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 3 files changed +9
-5
lines changed
Expand file tree Collapse file tree 3 files changed +9
-5
lines changed Original file line number Diff line number Diff line change @@ -21,7 +21,7 @@ It integrates the following tools:
2121- Pre-commit with black, flake8, isort and mypy for static analysis
2222- Pytest for code and coverage
2323- Sphinx for tutorials, how-to guides, explanations and reference documentation
24- - Github Actions for code and docs CI and deployment to PyPI and Github Pages
24+ - GitHub Actions for code and docs CI and deployment to PyPI and GitHub Pages
2525- VSCode settings using black, flake8, isort and mypy on save
2626
2727The ``skeleton `` branch of this module contains the source code that can be
Original file line number Diff line number Diff line change @@ -77,17 +77,21 @@ You can then view the docs output with a web browse::
7777
7878 firefox build/html/index.html
7979
80- Pushing to Github
80+ Pushing to GitHub
8181-----------------
8282
83- To push the resulting repo to Github, run the following::
83+ To push the resulting repo to GitHub, first create an empty repo from the GitHub
84+ website, then run the following::
8485
8586 git remote add $(cat .gitremotes)
8687 git push -u github master
8788
8889This will then run the continuous integration (CI) jobs, which run the tests and
8990build the docs using the commands above.
9091
92+ Once the docs build has passed, you can use the Settings on the repo page on the
93+ GitHub website to enable github pages publishing of the ``gh-pages `` branch.
94+
9195What next?
9296----------
9397
Original file line number Diff line number Diff line change @@ -127,7 +127,7 @@ def main(args=None):
127127 sub .set_defaults (func = new )
128128 sub .add_argument ("path" , type = Path , help = "Path to new repo to create" )
129129 sub .add_argument (
130- "--org" , default = "dls-controls" , help = "Github org, default dls-controls"
130+ "--org" , default = "dls-controls" , help = "GitHub org, default dls-controls"
131131 )
132132 sub .add_argument (
133133 "--package" , default = None , help = "Package name, defaults to directory name"
@@ -143,7 +143,7 @@ def main(args=None):
143143 sub .set_defaults (func = existing )
144144 sub .add_argument ("path" , type = Path , help = "Path to new repo to existing repo" )
145145 sub .add_argument (
146- "--org" , default = "dls-controls" , help = "Github org, default dls-controls"
146+ "--org" , default = "dls-controls" , help = "GitHub org, default dls-controls"
147147 )
148148 sub .add_argument (
149149 "--package" , default = None , help = "Package name, defaults to directory name"
You can’t perform that action at this time.
0 commit comments