question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Build single pages with docutils (instead of Sphinx)

See original GitHub issue

Describe the enhancement you’d like

I would like a way to configure MyST from docutils.conf instead of conf.py.

Does this solve a specific problem?

I compile most of my documents using plain docutils, not Sphinx. This is because Sphinx isn’t great for single-page documents: the setup process for a new document is very heavy, and it’s strongly geared towards producing books, not articles or reports.

On the other hand, Docutils works great for short to medium-length single-file documents.

Being able to use Markdown instead of reST would be nice, but as far as I can tell there’s no way to configure MyST from docutils.conf instead of Sphinx’ conf.py, so there’s no way to enable Markdown extensions or configure MyST in any way when using the plain-Docutils pipeline.

What alternatives exist?

I’m not aware of a good workaround at the moment.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

2reactions
cpitclaudelcommented, Aug 23, 2021

Cool. Then I will prepare a PR to explore things a bit. I wanted to make sure that it wouldn’t be wasted work. I think docutils is a great pipeline, and I think MyST is a neat language, so having more robust integration between the two would be very cool.

1reaction
cpitclaudelcommented, Aug 23, 2021

Also, of course, there’s the hope that we could have MyST as part of the standard docutils pipeline at some point, as was discussed in https://github.com/executablebooks/MyST-Parser/issues/347

Read more comments on GitHub >

github_iconTop Results From Across the Web

Single page builds - MyST-NB - Read the Docs
MyST-NB offers a renderer, parser and CLI-interface for working directly with Docutils, independent of Sphinx, as described below. Note. Since these tools are ......
Read more >
Configuration - Sphinx documentation
A dictionary of values to pass into the template engine's context for all pages. Single values can also be put in this dictionary...
Read more >
Ensure good design and learn from docutils/sphinx #18 - GitHub
In this document we outline the general design decisions for a generic MyST parser, and then how this applies to the Javascript parser...
Read more >
How Jupyter Book and Sphinx relate to one another
Docutils has no concept of multi-page documents, and so Sphinx uses the basic Docutils ... Jupyter Book instead uses a single Table of...
Read more >
reStructuredText Directives - Docutils
For example, the following "note" admonition directive contains one paragraph ... generator like Sphinx rather than the "header" and "footer" directives.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found