ikalchev
More Sphinx Work
Putting this issue here to track progress on the Sphinx Documentation.
Todo:
- We will need to go through more of the project and switch over to sphinx docstrings. I only hit Accessory, Bridge, and AccessoryDriver.
- Ubuntu LTS Installation Pre-Requisites.
- More things, please comment for what you see missing.
- intro/examples.rst
- intro/tutorial.rst
- intro/overview.rst
No, this basically, is for the work that needs to be done still to finish out the documentation so that others can see our needs for documentation, and can also contribute.
The tag will be good for organizational/filtering purposes for people looking specifically for documentation work.
Yeah, also, since you are more familiar with the scope of the project, can you please let me, and others here, know what else besides the 3 classes I already hit, that need to be documented with priority?
Also, it should be ready to be able to hook into readthedocs.io
https://docs.readthedocs.io/en/latest/getting_started.html#sign-up-and-connect-an-external-account
- pyhap/characteristic.py
- pyhap/service.py
- pyhap/util.py - good to have but not at all that important right now
Yes, I was thinking of readthedocs and will probably do it in the following days.
Keep in mind that the sphinx docstrings are different.
:param x:
instead of
@param x:
Doesn't look like the PYTHONPATH is getting set on rtd. API is not building out the autoclass. Investigating.
I barely had the time to do the Travis and rtd integrations, hopefully I full find more time soon. Thanks for keeping an eye on that.
No problem. Got it figured out. Will post more info in a few minutes once I have everything nailed down.
Ok, there may be a few settings to change on RTD.
Under the project panel, Admin -> Advanced Settings
- We need to have
Install your project inside a virtualenv using setup.py installchecked. Python interpreterneeds to be set toCPython3.x
I will submit a PR for the code changes needed.
Also, these have been documented from the last doc merge.
- Characteristic
- CharLoader
- Service
- ServiceLoader
- Util