...
- At a command prompt, go to the
edx-documentation
directory. - Enter the following command:
./run_tests.sh
The command will build all projects from scratch. - Review results at the end. If there are warnings or errors, address and run again.
Test Links (doc team only)
About once every six months, run the linkchecker tool in Sphinx to make sure all the links work.
- At a command prompt,
cd
to theen_us
directory. - Enter the following command:
make linkchecker
The command checks all links in all projects. - Review results for the project. If there are warnings or errors, address and run again.
For more information, see the final comment on documentation PR 1267.