Divide the README into rst docs

[asmacdo]

This commit includes the boilerpate for sphinx docs by using the
plugin_template.

https://pulp.plan.io/issues/4670
re #4670

[pep8speaks]

Hello @asmacdo! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file docs/conf.py:

Line 22:1: E265 block comment should start with '# '
Line 27:1: E265 block comment should start with '# '
Line 40:1: E265 block comment should start with '# '
Line 60:1: E265 block comment should start with '# '
Line 64:1: E265 block comment should start with '# '
Line 66:1: E265 block comment should start with '# '
Line 73:1: E265 block comment should start with '# '
Line 76:1: E265 block comment should start with '# '
Line 80:1: E265 block comment should start with '# '
Line 84:1: E265 block comment should start with '# '
Line 90:1: E265 block comment should start with '# '
Line 102:1: E265 block comment should start with '# '
Line 105:1: E265 block comment should start with '# '
Line 109:1: E265 block comment should start with '# '
Line 112:1: E265 block comment should start with '# '
Line 116:1: E265 block comment should start with '# '
Line 121:1: E265 block comment should start with '# '
Line 130:1: E265 block comment should start with '# '
Line 134:1: E265 block comment should start with '# '
Line 137:1: E265 block comment should start with '# '
Line 141:1: E265 block comment should start with '# '
Line 147:1: E265 block comment should start with '# '
Line 150:1: E265 block comment should start with '# '
Line 153:1: E265 block comment should start with '# '
Line 156:1: E265 block comment should start with '# '
Line 159:1: E265 block comment should start with '# '
Line 162:1: E265 block comment should start with '# '
Line 167:1: E265 block comment should start with '# '
Line 170:1: E265 block comment should start with '# '
Line 175:1: E122 continuation line missing indentation or outdented
Line 176:1: E122 continuation line missing indentation or outdented
Line 176:1: E265 block comment should start with '# '
Line 178:1: E122 continuation line missing indentation or outdented
Line 179:1: E122 continuation line missing indentation or outdented
Line 179:1: E265 block comment should start with '# '
Line 181:1: E122 continuation line missing indentation or outdented
Line 182:1: E122 continuation line missing indentation or outdented
Line 182:1: E265 block comment should start with '# '
Line 187:1: E265 block comment should start with '# '
Line 191:1: E265 block comment should start with '# '
Line 194:1: E265 block comment should start with '# '
Line 197:1: E265 block comment should start with '# '
Line 200:1: E265 block comment should start with '# '
Line 203:1: E265 block comment should start with '# '
Line 207:1: E265 block comment should start with '# '
Line 210:1: E265 block comment should start with '# '
Line 213:1: E265 block comment should start with '# '
Line 216:1: E265 block comment should start with '# '

Comment last updated at 2019-04-25 15:49:36 UTC

[asmacdo]

This PR lays the foundation to publish to readthedocs. To build locally including the rest documentation, create the following script in the pulp_docker/docs dir:

source ~/.bashrc
prestart
cd ~/devel/pulp_docker/docs/
sleep 2 
make clean
make html
cd ~/devel/pulp_docker/docs/_build/html
python2 -m SimpleHTTPServer 1234

ssh into a pulplift env opening port 1234:

vagrant ssh pulp3-source-fedora28 -- -L 1234:localhost:1234

Run the script, and the full docs are visible at localhost:1234/

[asmacdo]

I never figured out why, but pulp-python had some trouble publishing to readthedocs, and removing the theme seemed to fix it, so that may be necessary here as well. pulp/pulp_python#232