Create docs subdirectory and Sphinx scaffolding

[sydneyli]

Just ran sphinx-quickstart docs in the root directory.

Only plugin/extension I added was autodoc. Let me know if you'd prefer it set up differently.

[codecov-io]

Codecov Report

Merging #77 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #77   +/-   ##
=======================================
  Coverage   91.49%   91.49%           
=======================================
  Files           6        6           
  Lines         635      635           
=======================================
  Hits          581      581           
  Misses         54       54

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b88e1b...ed69e91. Read the comment docs.

[codecov-io]

Codecov Report

Merging #77 into master will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #77      +/-   ##
==========================================
+ Coverage   91.49%   91.52%   +0.02%     
==========================================
  Files           6        6              
  Lines         635      637       +2     
==========================================
+ Hits          581      583       +2     
  Misses         54       54

Impacted Files	Coverage Δ
apacheconfig/loader.py	89.16% <0%> (+0.07%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b88e1b...6553b27. Read the comment docs.

[etingof]

Awesome!

These .gitignore files in the commit - do we need them?

Should we hook up docs building to the CI job?

[etingof]

Ah, we should probable introduce something like test-requirements.txt listing devel/tesing dependencies e.g. Sphinx...

[etingof]

May be in upcoming/other commit, we'd probably want to link some of the newly introduced docstrings to this docs infrastructure to see how it works. I suspect you have done that already elsewhere, though. ;-)

[sydneyli]

These .gitignore files in the commit - do we need them?

The .gitignore files are to make git keep the _static and _templates subdirectories (the sphinx build seems to expect that they exist).

Should we hook up docs building to the CI job?

Yep, will do!

[sydneyli]

Should we hook up docs building to the CI job?

I'm having a bit of trouble getting this to work on Py 2.6/3.2/3.3 for the time being-- I'll revert for the time being and create a new issue for this. @etingof does that sound okay?

Ah, we should probable introduce something like test-requirements.txt listing devel/tesing dependencies e.g. Sphinx...

Right now it's just test-requirements and requirements-- should we rename test-requirements to dev-requirements and add Sphinx as a dependency there?

[etingof]

Should we hook up docs building to the CI job?

I'm having a bit of trouble getting this to work on Py 2.6/3.2/3.3 for the time being-- I'll revert for the time being and create a new issue for this. @etingof does that sound okay?

Sure! I am curious what exactly is not working? Sometimes it's necessary to pin on specific versions of Sphinx (or any other dependency) which is still compatible with old Python.

On the other hand, those Pythons are seriously obsolete. If the issue is not trivial, may be we could just avoid building docs on them.

Ah, we should probable introduce something like test-requirements.txt listing devel/tesing dependencies e.g. Sphinx...

Right now it's just test-requirements and requirements-- should we rename test-requirements to dev-requirements and add Sphinx as a dependency there?

I think requirements.txt is a de-facto (?) standard for listing runtime dependencies. I'd not rename this file into dev-requirements.txt.

[sydneyli]

On the other hand, those Pythons are seriously obsolete. If the issue is not trivial, may be we could just avoid building docs on them.

Yep, I think all those Pythons are actually all deprecated! I'll also make an issue for dropping support through Py 3.3.

I think this is good to go-- like the linter, I'm just building docs on the most recent Python for the time being.

[etingof]

Yep, I think all those Pythons are actually all deprecated! I'll also make an issue for dropping support through Py 3.3.

They are indeed very old and rarely (?) used. We should probably drop them altogether once we run into a reasonable limitation... My only worry is that there might be people out there still stuck at 2.6...