TheJacksonLaboratory / isopretGO

Isoform function prediction and interpretation
https://thejacksonlaboratory.github.io/isopretGO/
GNU General Public License v3.0
6 stars 2 forks source link

ReadTheDocs documentation not found #147

Closed hansenp closed 10 months ago

hansenp commented 1 year ago

I get a “404 Not Found” error when I follow the ReadTheDocs link at the very end of README.md. Is this a typo in the URL or does the documentation not yet exist on ReadTheDocs?

But I was able to create the ReadTheDocs locally as follows:

$ cd docs
$ pip install sphinx
$ pip install sphinx-rtd-theme
$ make html

Some warnings and errors were reported during the creation. I was then able to view the documentation starting from docs/_build/html/index.html.

Maybe we should provide instructions for creating the documentation locally on the README.md for now, at least as long as the documentation is not yet public on ReadTheDocs.

pnrobinson commented 10 months ago

I have refactored the documentation for mkdocs, which is easier and nicer. Still needs some work, but it will replace the RTD and will go public next week.