Documentation only

[BenjaminDev]

Description

Addresses #107
Added sphinx documentation see example. This means we need to write docstrings in a sphinx compatible way. See benjaminDev/pydp@distributions pr for examples. This pr has a workflow that will run on pushes to dev which will build and put the built docs in the gh-pages branch.

Affected Dependencies

Added dev dependencies: sphinx and sphinx-rtd-theme.

How has this been tested?

• Tested on personal fork and it works their.

Checklist

• I have followed the Contribution Guidelines and Code of Conduct
• I have commented my code following the OpenMined Styleguide
• I have labeled this PR with the relevant Type labels
• My changes are covered by tests

Todo:

This pr will has a workflow that will run on pushes to dev which will put the built docs in the gh-pages branch. To serve these an Openmined developer must go to settings and activate github pages as shown below.

[chinmayshah99]

Hey @BenjaminDev ,
We already have readthedocs.org integration over here: https://pydp.readthedocs.io/en/latest/
So we just need to put everything in /docs folder.

Or is this PR a better solution to that?

[BenjaminDev]

hahaha. Okay I missed that. I have never used read the docs. I didn't see a .readthedocs.yml file anywhere.

Can you point it to the gh-pages branch? or can readthedocs run the build command?d

I'd say the only issue is somewhere we need to build the docs as it'll get messy if we commit all the built files to github. We'd need to look into what readthedocs offers and whether sphinx can play nicely with sphinx.
Seems it can.

sphinx:
  builder: html
  configuration: conf.py
  fail_on_warning: true

Where is our .readthedocs.yml file?

Is this current solution better? I'd say same same. But if other OpenMined projects are using readthedocs service then let's do the same.

[chinmayshah99]

Can we add markdown support?

[BenjaminDev]

Can we add markdown support?

I'm sure we can. which files are in markdown that need to be added? Unless they exist let's leave them to another PR. I'm sure there will be plenty to add.

[chinmayshah99]

Can we remove python-dp? or is that essential to the build?

[chinmayshah99]

Also, is this requirement file necessary?

[BenjaminDev]

The way sphinx works is by stripping the docs from the docstrings of the released (installed) package. Yes! this requirements.txt is needed and is used by reathedocs (or the github action proposed) when the docs are built.

[chinmayshah99]

Also since we have added readthedocs, can we remove the github action?

[BenjaminDev]

Also since we have added readthedocs, can we remove the github action?

Yeah we should. I'll do that.