- vastly improved docs for deploy-log command.
- use readthedocs.org theme
Details
Details
- Maniphest Tasks
- T116638: Document Scap3 deploy-log
- Reviewers
thcipriani dduvall demon - Commits
- rMSCA9194d77e9ed1: Improved `deploy-log` documentation, reorganized the TOC
- Patch without arc
- git checkout -b D35 && curl -L https://phabricator.wikimedia.org/D35?download=true | git apply
tox -e doc
Diff Detail
Diff Detail
- Repository
- rMSCA Scap
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
Event Timeline
| docs/legacy_scap_architecture.rst | ||
|---|---|---|
| 7 ↗ | (On Diff #114) | When I run tox -e doc it complains about this for some reason. Warning, treated as error: /Users/dduvall/Projects/mediawiki/tools/scap-vagrant/scap/docs/legacy_scap_architecture.rst:7: WARNING: nonlocal image URI found: https://upload.wikimedia.org/wikipedia/commons/4/4d/Scap-diagram.png |
| docs/scripts.rst | ||
| 50 | Looks like the indentation/wrapping might have gotten messed up here. | |
| docs/legacy_scap_architecture.rst | ||
|---|---|---|
| 7 ↗ | (On Diff #114) | Well I'd rather reference the file on commons instead of including a redundant image file in the docs. If sphinx wants to complain then so be it. |
| docs/scripts.rst | ||
| 50 | how so? The indentation was intentional, to make sphinx format it differently from the rest (just for emphasis mainly) | |
| docs/legacy_scap_architecture.rst | ||
|---|---|---|
| 7 ↗ | (On Diff #114) | That's fine if we can get tox not to choke on it, but as is it considers this (and all warnings, afaik) an error. |
| docs/scripts.rst | ||
| 50 | Oh, ok! I didn't realize that because I didn't past the tox error to actually view it. Maybe just fix the wrapping on line 47 and add a period then. | |
| docs/legacy_scap_architecture.rst | ||
|---|---|---|
| 7 ↗ | (On Diff #114) | It doesn't happen when I run tox :-/ |