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

add readthedocs hosted documentation #122

Merged
merged 12 commits into from
Apr 5, 2018
Merged

add readthedocs hosted documentation #122

merged 12 commits into from
Apr 5, 2018

Conversation

edaniszewski
Copy link
Contributor

this PR largely just adds in documentation that will be hosted on readthedocs.

the slate API docs are still here, but will no longer be hosted. I still need to figure out how to either host them on github pages while also supporting readthedocs, or how to link them directly into the readthedocs files. I'll save that issue for a different day. Once checked in, these docs should appear at http://synse-server.readthedocs.io/en/latest/

I've temporarily enabled rtd builds on this branch so these docs can be read there (probably easier than reading through all the .rst files here): http://synse-server.readthedocs.io/en/rtd-docs/

Any feedback, suggestions, comments, etc is welcome as always.

I'll squash all of these commits down when it comes time to merge.

fixes #120

@codecov-io
Copy link

codecov-io commented Apr 5, 2018

Codecov Report

Merging #122 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #122   +/-   ##
=======================================
  Coverage   88.98%   88.98%           
=======================================
  Files          40       40           
  Lines        1080     1080           
=======================================
  Hits          961      961           
  Misses        119      119

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 892e91e...940d897. Read the comment docs.

@edaniszewski edaniszewski merged commit 039c8f6 into master Apr 5, 2018
@edaniszewski edaniszewski deleted the rtd-docs branch April 5, 2018 21:20
edaniszewski pushed a commit to edaniszewski/synse-server that referenced this pull request Dec 9, 2021
…nits

Airflow sensor units are millimeters per second.
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.

add comprehensive user documentation
3 participants