Adds a paragraph to the user docs describing expected_outputs.log and missing_outputs.log and a page to the developer docs for logging in general, including the new functionality.
[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the source branch of the repository.
[x] My commit messages follow best practices.
[x] My code follows the established code style of the repository.
[ ] I added tests for the changes I made (if applicable).
[ ] I updated the changelog.
[x] I added or updated documentation (if applicable).
[x] I tried running the project locally and verified that there are no visible errors.
Developer Certificate of Origin
Developer Certificate of Origin
```
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
```
Fixes
Documents https://github.com/FCP-INDI/C-PAC/pull/1691 by @shnizzedy
Description
Adds a paragraph to the user docs describing
expected_outputs.logandmissing_outputs.logand a page to the developer docs for logging in general, including the new functionality.Technical details
I wrote a factory function to generate the logging methods for
MockLogger, https://github.com/FCP-INDI/C-PAC/blob/47c407e628baad321923b27ab73e4f9c39d3193c/CPAC/utils/monitoring/custom_logging.py#L42-L56 so I added code to initialize an instance ofMockLoggerand add the generated methods before Sphinx generates the docs: https://github.com/FCP-INDI/fcp-indi.github.io/blob/c13b6a3c0da0e7b6eadbc0195967bb723534ce3d/docs/_sources/conf.py#L580-L589Screenshots
Checklist
Update index.md).sourcebranch of the repository.Developer Certificate of Origin
Developer Certificate of Origin
``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```