Minor fix development docs to prevent deprecation warning #5371
Conversation
Running tests from securedrop/securedrop prints a deprecation warning. The bin/dev-shell script sets TOPLEVEL from Git output and doesn't depend on the current directory, so there is no need to change directory before running the bin/dev-shell examples. The lines become longer, but still fit the Read the Docs code block width in all orientations of an iPad-sized device and readability remains unchanged.
gonzalo-bulnes
requested review from
emkll,
kushaldas,
redshiftzero and
zenmonkeykstop
as code owners
|
LGTM. I've verified that the revised commands work as expected. Thank you, @gonzalo-bulnes!
That is indeed likely the cause of the error you're seeing. The docs tooling still depends on a virtualenv, see the instructions here: |
|
Thanks for the pointer @eloquence. I had gone through the docs and couldn't install the current requirements. (I'm currently working from an Ubuntu 20.04 LTS machine.) I went back to the installation steps and narrowed down the issue to the specific versions of two dependencies:
Because I guess it can inform #4768, I documented the test bench for future reference. Also, for what is worth, both currently locked versions can be installed successfully on Ubuntu 18.04 LTS. |
|
Excellent flags @gonzalo-bulnes, thanks for the detailed report-back. Are you able to get the docs-build to work if you update those requirements locally? |
|
@eloquence I'll reply in #5384 : ) |
Status
Ready for review
Description of Changes
Running tests from the
securedrop/securedropdirectory prints a deprecation warning:This PR applies the suggestion of running the tests from the
securedropdirectory instead.Considerations
The
bin/dev-shellscript setsTOPLEVELfrom Git output and doesn't depend on the current directory, so there is no need to change directory before running thebin/dev-shellexamples.The lines become longer, but still fit the width of the Read the Docs code block in all orientations of an iPad-sized device, and readability remains unchanged. (Smaller devices already required horizontal scrolling.)
Testing
Deployment
No special considerations for deployment.
Checklist
make docs-lint) passed locallysecuredrop/docs/kernel_troubleshooting.rst:110:Cannot analyze code. No Pygments lexer found for "none".(I worked around it.)