Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.41 KB

README.md

File metadata and controls

62 lines (39 loc) · 2.41 KB

WPCD Workflows documentation

Migrated eufus.eu documentation available as http://wpcd-workflows.github.io/ and http://wpcd-workflows.readthedocs.io/ (autobuild without assets at this point)

To commit to this repository user needs to become Collaborator and to create "personal access token" with admin:repo_hook, public_repo, repo:status at your https://github.com/settings/tokens page.

Created TOKEN is then used as a user/password for HTTPS access to the repository.

If there are small edits without adding figures and sectioning then editing on Github directly is OK too. Just make sure that you follow reStructuredText conventions and check updated page at https://wpcd-workflows.github.io after automatic build finishes in few minutes.

To clone please use:

git clone https://TOKEN@github.com/WPCD-Workflows/documentation.git wpcd-doc
chmod og-rw wpcd-doc/.git/config

To change the TOKEN or remote URL:

git remote set-url origin https://TOKEN@github.com/WPCD-Workflows/documentation.git
chmod og-rw .git/config

To commit large files to the https://github.com/WPCD-Workflows/assets repository use

make push asset=your.file
make push asset=source/static/Phase4.10b.8_HTML.zip
make push asset='source/archive/*.zip'

If using new location for large files then edit ASSETS wildcard in Makefile

Building documentation locally

make html

Publishing documentation

Unless the directory is cloned firstly a local directory WPCD-Workflows.github.io will be created and the content of the HTML documentation can be viewed with

xdg-open ../WPCD-Workflows.github.io/index.html

To be able to push documentation remove WPCD-Workflows.github.io and

git clone https://TOKEN@github.com/WPCD-Workflows/WPCD-Workflows.github.io.git

at the same level as wpcd-doc. To push everything therein use:

git add --all .
git commit -m "Updated public documentation"
git push

Note that publishing documentation to http://wpcd-workflows.github.io is not necessary anymore as Circle CI builds them at every commit automatically. See jobs https://circleci.com/gh/WPCD-Workflows/documentation and implementation notes at https://gist.github.com/WPCD-Workflows/9ca6f68284f03996df4771092086c6fc

For convenience CircleCI Sphinx build logs are accessile through http://wpcd-workflows.github.io/sphinx.log for spotting compilation errors when editing documentation directly at github.