...
Sphinx converts .rst files into PDF and HTML online. This tool also requires XCode.
...
that you
...
have already installed XCode.
In a terminal window, run the following commands from the edx-documentation directory:
- sudo python -m ensurepip
Note: You will be prompted for a password. Enter your machine password and then click Enter. - sudo pip install virtualenv
- virtualenv venv
- . venv/bin/activate
- pip install -r shared/travis_requirements.txt
Note: Ensure that you are pointing to the correct local directory from Terminal (the Command line) so that Sphinx can successfully access the necessary themes and files.
SnagIt
The doc team uses SnagIt to edit images. You can also use SnagIt to capture images, or you can use the native image capturing capability on a Mac (CMD+SHIFT+4). If you use SnagIt to capture the image, the image opens in SnagIt automatically.
...