2018-09-20 10:49:38 -07:00
|
|
|
# docbot
|
|
|
|
|
|
|
|
|
|
Builds & deploys user guide.
|
|
|
|
|
|
2018-11-09 12:33:42 -08:00
|
|
|
The in-progress CI4 user guide, warts & all, is rebuilt in a nested
|
2018-09-20 10:49:38 -07:00
|
|
|
repository clone (`user_guide_src/build/html`), with the result
|
|
|
|
|
optionally pushed to the `gh-pages` branch of the repo.
|
|
|
|
|
That would then be publically visible as the in-progress
|
2018-11-09 12:33:42 -08:00
|
|
|
version of the [User Guide](https://codeigniter4.github.io/CodeIgniter4/).
|
2018-09-20 10:49:38 -07:00
|
|
|
|
2019-03-12 13:45:20 -07:00
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
You must have python & sphinx installed.
|
|
|
|
|
|
2018-09-20 10:49:38 -07:00
|
|
|
## Audience
|
|
|
|
|
|
|
|
|
|
This script is intended for use by framework maintainers,
|
|
|
|
|
i.e. someone with commit rights on the CI4 repository.
|
|
|
|
|
|
|
|
|
|
This script wraps the conventional user guide building,
|
|
|
|
|
i.e. `user_guide_src/make html`, with additional
|
|
|
|
|
steps.
|
|
|
|
|
|
|
|
|
|
You will be prompted for your github credentials and
|
|
|
|
|
GPG-signing key as appropriate.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Inside a shell prompt, in the project root:
|
|
|
|
|
|
2018-09-22 01:33:15 -07:00
|
|
|
`admin/docbot [deploy]`
|
2018-09-20 10:49:38 -07:00
|
|
|
|
|
|
|
|
If "deploy" is not added, the script execution is considered
|
|
|
|
|
a trial run, and nothing is pushed to the repo.
|
|
|
|
|
|
|
|
|
|
Whether or not deployed, the results are left inside
|
2018-09-26 07:16:41 -07:00
|
|
|
user_guide_src/build (which is git ignored).
|
2019-03-12 13:45:20 -07:00
|
|
|
|
|
|
|
|
Generate these and the API docs together with the 'alldocs' script.
|
