add sphinx docs and move info from readme there about teiphy HOT 6 CLOSED

Okay, I've converted readme.md to a single readme.rst file directly using pandoc. Based on the structure I'm seeing for the docs in dcodex, I imagine that this might end up being divided into smaller files or that we'll add other docs later, but again, I'm not familiar with how the process of documentation generation works.

from teiphy.

Thanks, Rob! I've generated the build files and built the HTML page locally via

poetry run sphinx-build -b html docs docs/_build/html

and the result looked as expected. I probably need to do some additional steps to publish the page online, so I'll leave this issue open for now.

from teiphy.

Hey @rbturnbull! I just pulled the latest changes, and the updated documentation looks great! And thanks for the paper stub; I hope to get started on that soon! 😄

from teiphy.

I've seen and edited some of the docs for dcodex before, and I should be able to convert the readme in Markdown to RST using pandoc, but I might need some help with the next step of "building" the docs and automating this process with GitHub actions per #11.

from teiphy.

great work Joey. Here are some instructions:

• Install sphinx as a dev dependency with: poetry add --dev Sphinx
• Then use sphinx to create the docs project: sphinx-quickstart
• more info here: https://www.sphinx-doc.org/en/master/usage/quickstart.html
• install a sphinx theme. I usually use readthedocs. To install that you can do this: poetry add --dev sphinx-rtd-theme
• then you add the theme to your conf.py with the line: html_theme = "sphinx_rtd_theme"

from teiphy.

Hi @jjmccollum - I've refactored the docs and the readme a bit. I've merged the pull request myself because I wanted the docs to deploy to GH pages. You can see the update here: https://jjmccollum.github.io/teiphy/

I've also added a stub for the paper. it is converted to a PDF each push and it is deployed here: https://jjmccollum.github.io/teiphy/joss-draft.pdf

from teiphy.