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.

Sign up for GitHub

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

Jump to bottom

WIP: use Sphinx to generate Markdown version of docs #13308

Closed
wants to merge 30 commits into from
Closed

WIP: use Sphinx to generate Markdown version of docs #13308

wants to merge 30 commits into from

Conversation

StefanKarpinski
Copy link
Member

No description provided.

@kshyatt kshyatt added the docsystem The documentation building system label Sep 29, 2015
@StefanKarpinski StefanKarpinski force-pushed the sk/markdown branch 5 times, most recently from bfe531b to 1c4583e Compare September 29, 2015 20:27
@StefanKarpinski StefanKarpinski force-pushed the sk/markdown branch 3 times, most recently from 901516f to 74977e3 Compare October 24, 2015 13:10
@StefanKarpinski StefanKarpinski force-pushed the sk/markdown branch 3 times, most recently from 3b2a854 to 2399192 Compare November 10, 2015 21:09
@StefanKarpinski
use Sphinx to generate Markdown version of docs
62746ff
@StefanKarpinski
rename: MarkdownTranslator => TextTranslator, titles, literals, math
ee33e6e
@StefanKarpinski
prepend Jekyll header to allow rendering via Jekyll
74feb46 
This isn't our target renderer, but it's a decent proxy for now.
@StefanKarpinski
xml Makefile target; indent by 4 and wrap at column 92.
e814a70
@StefanKarpinski
remove unused methods from writers/markdown.py
ade6c2d
@StefanKarpinski
emit Julia code blocks as indented code, others using ```language
d698e1f
@StefanKarpinski
remove quote handlers in markdown.py (no longer needed)
19d384b
@StefanKarpinski
docs: make generated tables closer to real Markdown syntax
29f3617
@StefanKarpinski
markdown.py: displaymath and inline math using Scholarly convention
ea484ef
@StefanKarpinski
markdown.py: emit rubrics as titles; unindent admonitions
c71db24 
delete methods for "problematic" RST nodes – no more exist
@StefanKarpinski
markdown.py: allow arbitrary strings for indentation
99d8f88
@StefanKarpinski
markdown.py: use line blocks to emit sidebar sections
a75f7b6 
We could use similar formatting for various admonitions.
@StefanKarpinski
markdown.py: print unknown nodes for easier debugging
757ed1e
@StefanKarpinski
render definition lists as "term:\n text..."
837491f
@StefanKarpinski
delete unused termsep method
3acb8be
@StefanKarpinski
indicate return type with :: instead of ->
8cfff65
@StefanKarpinski
emit function and data descriptions in backticks
057cc1f
@StefanKarpinski
change formatting of definitions and sidebars
5406c1e
@StefanKarpinski
move footnote and citation methods together
bc0e769
@StefanKarpinski
emit pandoc-style [^1] format for footnotes
477077f
@StefanKarpinski
emit citations in pandoc format, e.g. [@Karpinski2015]
41ab009
@StefanKarpinski
seems we don't need "description" methods anymore
4d11237
@StefanKarpinski
emit hypertext links in [text](link) format
17d4e2c
@StefanKarpinski
Format function descriptions as definition lists.
b9f1246 
This has each signature on a separate line followed by a colon in
backticks.
@StefanKarpinski
Render section referenes in square brackets.
3e9f6f8
@StefanKarpinski
title references are no longer used (all instances were mistakes)
cbb75f2
@StefanKarpinski
markdown.py: don't emit the YAML header anymore
0e732d2
@StefanKarpinski
WIP on transforming Markdown into an HTML website.
9608e5c
@StefanKarpinski
wip
b6f2a14
@StefanKarpinski
use highlight.js to do syntax highlighting
d65c471 
see https://highlightjs.org/ – custom generated .js file
@StefanKarpinski StefanKarpinski mentioned this pull request Dec 10, 2015
Closed
13 tasks
@StefanKarpinski StefanKarpinski mentioned this pull request Jun 27, 2016
Closed
@hayd hayd mentioned this pull request Sep 20, 2016
Merged
4 tasks
@DilumAluthge DilumAluthge deleted the sk/markdown branch March 25, 2021 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docsystem The documentation building system
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@StefanKarpinski @kshyatt