-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial docs #21
base: master
Are you sure you want to change the base?
Initial docs #21
Conversation
@hunterowens this is really cool! I was finally able to get I've setup GitHub pages for static HTML and Jekyll sites, but not for something like this with custom build commands. I found this write-up of a possible flow but it doesn't get in to automation. Do you have experience with that? Would CircleCI or Travis or something be able to help here? @allejo maybe you've setup a python project with GH pages docs that build on commit/PR, or something similar? |
I see that Sphinx also includes an extension |
@thekaveman read the docs is your friend. I'll add a link in the README |
Also re: make on windows, you can install a ubuntu VM from the windows store now, which is how I use ssh, make and other tools on my work computer. |
rebased on |
Rebased on the forthcoming release in Added a small Docker setup for building and serving docs locally in a known environment. |
MDS Provider deserves some docs.
This PR creates a
docs
directory, where you can place.md
or.rst
files to generate documentation. You can then serve it on the web using github pages.The structure is as follows.
Use
make build
to build html docs.conf.py
defines some settings.Additionally, this PR adds a Pipfile with just dev dependencies.