Skip to content

Commit

Permalink
Update README and add docs/manual to gitignore (#270)
Browse files Browse the repository at this point in the history
* add docs/manual to .gitignore

* Update Manual README

* reorder paragraphs and fix wording

* remove space
  • Loading branch information
CalMacCQ authored Nov 13, 2023
1 parent 71fed86 commit 4948899
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ manual/build
manual/jupyter_execute
examples/_build/
*.ipynb_checkpoints
docs/manual
8 changes: 3 additions & 5 deletions manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,8 @@ Once the virtual environment is set up we can run the `build-manual` script from
./build-manual
```

Now the built html pages will appear in the local `docs/manual` directory. Its recommended to view the html pages locally after making changes to the source files.
Now the built html pages will appear in the local `docs/manual` directory.

If you want to make changes to the manual then you can commit changes to the source files on a local branch. Note that due to a current limitation of the manual build you will need to also commit changes to the built html file.
The manual contains many `jupyter-execute::` directives that run python code when the html is built. The manual build is also run on CI whenever changes are pushed to the pytket repository. If there is are any code snippets that give errors or warnings then the CI build will fail.

For example if edits were made to `manual_backend.rst`. The html file `manual_backend.html` will also need to be added to the pull request as well.

Note that the entire `docs/manual` directory gets deployed whenever a pull request is merged. The changes made in the pull request should show up in the github pages site as soon as the workflow run finishes.
If you are making changes to the manual then it is recommended to build the manual locally check the built html pages. If there are no issues then you can commit your change to a local branch and make a pull request.

0 comments on commit 4948899

Please sign in to comment.