Skip to content

[INFRA] Mkdocs configuration and RTD setup#42

Merged
chrisgorgo merged 3 commits intobids-standard:masterfrom
choldgraf:mkdocs
Oct 12, 2018
Merged

[INFRA] Mkdocs configuration and RTD setup#42
chrisgorgo merged 3 commits intobids-standard:masterfrom
choldgraf:mkdocs

Conversation

@choldgraf
Copy link
Copy Markdown
Collaborator

Here's a demo of the bids specification:

https://bids-specificaion.readthedocs.io/en/latest/

It's currently linked on RTD against my account, since I had to build the docs off of my fork. If we like how it looks, then we'll have to figure out how to transfer it to bids-standard.

I haven't figured out how to get the PDF/EPUB downloads working, though this should theoretically be possible in a relatively straightforward way.

@choldgraf
Copy link
Copy Markdown
Collaborator Author

relevant to #42 and #18

@chrisgorgo
Copy link
Copy Markdown
Contributor

Thanks.

Can you see pdflatex running in RTD logs? Maybe switching the theme to RTD will enable the version/downloads menu making the PDF accessible.

@choldgraf
Copy link
Copy Markdown
Collaborator Author

Actually I opened an issue in the RTD repo and it turns out that mkdocs does not support PDF generation:

readthedocs/readthedocs.org#4739

we could try to build with sphinx, in which case we'd get PDF generation. It shouldn't be too hard, but we won't have access to the theme you were using.

http://www.writethedocs.org/guide/tools/sphinx-themes/

@chrisgorgo
Copy link
Copy Markdown
Contributor

I also have a suspicion that tables will be problematic in the context of PDF generation.

@choldgraf
Copy link
Copy Markdown
Collaborator Author

@chrisfilo shall we merge this and I can make sure the readthedocs build works? I don't think we'll be able to demo it on the bids-standard org until it's merged into master

@chrisgorgo chrisgorgo merged commit 20ef76e into bids-standard:master Oct 12, 2018
@sappelhoff sappelhoff changed the title Mkdocs configuration and RTD setup [INFRA] Mkdocs configuration and RTD setup Sep 8, 2020
arokem added a commit to arokem/bids-specification that referenced this pull request Sep 15, 2025
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.

2 participants