Skip to content
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

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Initial docs #21

wants to merge 11 commits into from

Conversation

hunterowens
Copy link
Collaborator

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.

├── Makefile
├── conf.py
├── index.rst
└── validate.md

Use make build to build html docs. conf.py defines some settings.

Additionally, this PR adds a Pipfile with just dev dependencies.

@thekaveman
Copy link
Contributor

@hunterowens this is really cool! I was finally able to get make to work on Windows, and build and view these docs as HTML.

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?

@thekaveman
Copy link
Contributor

I see that Sphinx also includes an extension githubpages but I'm not sure if/how this helps.

@thekaveman
Copy link
Contributor

haha...

https://mds-provider.readthedocs.io/en/init-docs/

@hunterowens
Copy link
Collaborator Author

@thekaveman read the docs is your friend. I'll add a link in the README

@hunterowens
Copy link
Collaborator Author

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.

@thekaveman
Copy link
Contributor

rebased on master

@thekaveman thekaveman changed the base branch from master to dev November 19, 2018 19:40
@thekaveman thekaveman changed the base branch from dev to master December 31, 2018 19:24
@thekaveman thekaveman changed the base branch from master to mds-0.3 May 14, 2019 23:41
@thekaveman
Copy link
Contributor

Rebased on the forthcoming release in mds-0.3.

Added a small Docker setup for building and serving docs locally in a known environment.

@thekaveman thekaveman changed the base branch from mds-0.3 to master August 19, 2019 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants