Skip to content

Conversation

@kotfu
Copy link
Member

@kotfu kotfu commented Jul 17, 2019

Closes #722. When reviewing this PR, please don't review the content for accuracy. I've simply moved existing content into the new structure. We've got plenty of work still remaining which will be addressed in other issues/PRs:

  • write new content to cover undocumented capabilities
  • expand documentation on topics that are not fully described
  • update/correct existing documentation which no longer accurately describes current functionality

@kotfu kotfu requested a review from tleonhardt as a code owner July 17, 2019 03:46
@kotfu kotfu self-assigned this Jul 17, 2019
@codecov
Copy link

codecov bot commented Jul 17, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #726   +/-   ##
=======================================
  Coverage   97.15%   97.15%           
=======================================
  Files          13       13           
  Lines        3371     3371           
=======================================
  Hits         3275     3275           
  Misses         96       96

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 ab5a11c...03983bb. Read the comment docs.

Copy link
Member

@tleonhardt tleonhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took a quick look through and everything looks good

@NekoShinobi
Copy link

Just out of curiosity, is there a way to see our branches on readthedocs? Or is there something preventing from that happening?

@kotfu
Copy link
Member Author

kotfu commented Jul 17, 2019

We only push to readthedocs when we cut a release. However, you can easily view the documentation from any branch you have checked out in a web based format that looks exactly like readthedocs. From your checked out branch type:

 $ invoke livehtml

Then open your browser to http://localhost:8000. Your browser will show exactly what you would see in readthedocs.

@tleonhardt tleonhardt merged commit b8ab415 into master Jul 17, 2019
@tleonhardt tleonhardt deleted the integrate_legacy_documentation branch July 17, 2019 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Integrate all legacy documentation into new structure

4 participants