Use readthedocs #6

Closed timdiels closed 2 years ago

In GitLab by @timdiels on Apr 3, 2019, 16:29

We already have documentation at readthedocs, but the website does not reference it, we're not using it. Let's not let it go to waste and point to it from the website after bringing it up to date.

In GitLab by @timdiels on Apr 3, 2019, 16:29

https://coexpnetviz.readthedocs.io/en/latest/

In GitLab by @timdiels on Apr 3, 2019, 18:42

It does not updating/completing though, according to old notes these are done:

  api_guide.rst
  api_reference.rst
  developer_documentation.rst
  index.rst

and these are TODO for sure:

  cli.rst
  general.rst
      One or more screenshots of Cytoscape (like the ones on the website
      tutorial but showing the new node attrs and node types)
  changelog.rst

Likely we'll have to update all of it anyway though if we make more changes.

In GitLab by @timdiels on Apr 3, 2019, 19:08

To a degree this is a bit of an overarching issue, i.e. you should also update docs in the website and the plugin; make separate issues there for it there if you aren't going to update them as you finish this issue.

Remember that RTD docs should contain general info + CLI + API docs. Other interfaces reference to the general info and have further doc in their own repo for things specific to the interface; this makes most sense for versioning. We also noted this in this project's wiki but we should instead note it in the dev doc on RTD.

In GitLab by @timdiels on Apr 4, 2019, 14:38

When documenting the installation, reference Conda docs often, there are many pages which explain things well that may be of use to our users.

Decided a while back to only offer a cytoscape app from now on, I'll try putting all docs in the app's description instead of using readthedocs.

I've deleted the RTD docs as the primary docs are now at https://github.com/CoExpNetViz/CoExpNetViz/wiki

CoExpNetViz / coexpnetviz-python

Use readthedocs #6