generate docs without conversion #773
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
Member
jcb91
commented
Oct 19, 2016
jcb91
commented
- generate docs directly from repo markdown rather than rst converted via pypandoc
- get nbconvert_support docs directly from (improved) docstrings
- minor fixes to readme heading levels to fix RTD layout
- fix some docs syntax issues remaining from md -> rst conversion
- other minor readme tweaks
This was referenced Oct 19, 2016
|
Very nice! Is it ready to merge ? |
|
not quite, it required a bit of path-wrangling to get it working on readthedocs as well as locally, and a few fixes to markdown docs to deal with limitations of commonmark (e.g. no support for tables!). I think I've mainly fixed them, but haven't merged them into this docs branch/pr yet. Will try to fix it all up now. |
should help RTD layout be a little more sensible [skip CI]
addresses issue ipython-contrib#775. [skip CI]
Using markdown makes for easier comparison with the main README.md as well, as mentioned in ipython-contrib#776 [skip CI]
for ease of comparison with main readme, where we're not using features of rst
- add conda-forge badge - remove pypi downloads badges, which never get updated anyway
…to rst correctly.
* build docs through tox environment * build docs on travis. Travis build checks that we haven't broken docs which would get pushed to rtd * generate docs directly from repo markdown using recommonmark, rather than converting into new files with pandoc * unpin recommonmark version * remove redundant makefiles, rely on tox to do our docs building (we don't really reliably support anything bar html/json generation anyway) * remove redundant conda `docs/environment.yml` * fix docs version using `.bumpversion.cfg` * update docs readme
since commonmark (and hence recommonmark, which we use to generate our docs) doesn't support them.
since CommonMark disallows setext headings from being composed of text which would otherwise constitue a list item, see http://spec.commonmark.org/0.26/#setext-heading
primarily replacing html entities unsupported by commonmark
since commonmark doesn't do autolinking like gfm does
[skip CI]
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.