yaml2sbml-dev/yaml2sbml

Tidy up Docs/Deploy

jvanhoefer opened this issue · 6 comments

jvanhoefer commented

Some things still in the ToDo

  • Automatically update readthedocs when merging into master
  • Same for pypi
  • Restructure docs: Own Folder for all sphinx stuff, since this is distracting from examples, releasnotes & format docs, which in some sense is the important stuff...
jvanhoefer commented

@yannikschaelte I assigned you, since at least for the first two things you offered to do these... :)

  • 👍1
yannikschaelte commented

pypi see #80. Deployment to readthedocs should already be automatically happening as there exists a webhook (master+develop), I think.

yannikschaelte commented

FYI: I have enabled readthedocs for both master and develop branch. Thus, one can directly check how the docs look on develop branch already. If you want, you can also register your mail address on readthedocs.io under Notifications to get a notification of failed builds.

yannikschaelte commented

yaml2sbml.rtfd.io should target master, not develop. If that has not changed in a few minutes, some setting is still wrong. Edit: No master releases yet since rtd setup, need to wait until there are some.

jvanhoefer commented

Since we won't go for an own folder for sphinx, this is closed, right?

yannikschaelte commented

Sorry @jvanhoefer , I missed this. Yes, I would say it is fine -- the doc/ folder should be sufficiently tidied up now.