Reworks docs to use Spinx and Rst #316
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reworked the documentation to use Sphinx and reStructuredText markup rather than mark down. * Added a contributing page on how to get this to build locally (you're gonna need python) as well as a style guideline * Converted the shouldBe and shouldNotBe documentation to reST * Added a simple example of bringing in source from an external file in the shouldBe documentation. The example file pulls right from the unit test. I originally was going to create a seperate project for just documentation purposes, but the existing unit tests are so close that I didn't want to go down that route without further input. Seems like some slight tweaking to the existing unit tests on the formatting (and to throw in some Simpsons references) and they could be used for the docs too. Ultimately I think a "documentation" project will be needed. Little things like referencing which line numbers to bring in would make working with the unit test project and adjusting the using statements or adding a comment could throw off the documentation.
76 tasks
|
Looks like this PR ha gotten behind. I was going to merge in the content added by @JoeMighty but before I go down that route I wanted to make sure that 1) no other content was in the queue to be merged and 2) this is still something to be considered for doing. |
|
I am keen for it to go in, I have just been distracted on other things. @JoeMighty? |
|
Me too! I'm looking forward to seeing this. If you want to update the PR with the changes I've added then I can merge the PR. |
Merged TimeSpan documentation on ShouldNotBe.md into ShouldNotBe.rst and removed the .md file
|
Got the TimeSpan docs merged in and things look all set to be switched over. Not sure what has to be tweaked on the RTD side of things for it to see the change. I'm curious how that transition will go |
JakeGinnivan
added a commit
that referenced
this pull request
Oct 13, 2015
Reworks docs to use Spinx and Rst
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reworked the documentation to use Sphinx and reStructuredText markup
rather than mark down.
gonna need python) as well as a style guideline
the shouldBe documentation.
The example file pulls right from the unit test. I originally was going to
create a seperate project for just documentation purposes, but the
existing unit tests are so close that I didn't want to go down that route
without further input. Seems like some slight tweaking to the existing
unit tests on the formatting (and to throw in some Simpsons references)
and they could be used for the docs too.
Ultimately I think a "documentation" project will be needed. Little things
like referencing which line numbers to bring in would make working with
the unit test project and adjusting the using statements or adding a
comment could throw off the documentation.