Skip to content

Request for AsciiDoc support #17

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.

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

Closed
rphillips opened this issue Sep 6, 2010 · 8 comments
Closed

Request for AsciiDoc support #17

rphillips opened this issue Sep 6, 2010 · 8 comments

Comments

@rphillips
Copy link

Looks like a fantastic project. I don't know if the backend is modular to support other filetype backends, but I would like to see AsciiDoc support.

@ericholscher
Copy link
Member

It basically just uses Sphinx, so if you want AsciiDoc support, it would need to be supported in Sphinx.

If it's supported in Sphinx, then it should be pretty do-able in RTD.

@ericholscher
Copy link
Member

Ah, you're asking for us to be able to build and host AsciiDoc docs. I see, I'll keep this in mind. We're pretty sphinx focused at the moment, but it might be worth it at some point.

@rphillips
Copy link
Author

Thanks for the reply. In addition, I've been thinking hosting the epub files generated from Sphinx would be nice on readthedocs.

@ericholscher
Copy link
Member

Totally. Does it make sense to display the epub's, or should they just be downloadable?

@rphillips
Copy link
Author

Perhaps a button to the right or left of the 'View Docs' button for 'Download'. The button could automatically expand to 'EPUB', 'PDF', 'HTML Compressed', etc to allow a user to download the documentation for offline browsing.

Similarly, when a user has drilled down into a project's document, there is a "Brought to you by Read the Docs". A button there with an option to download pdf/epub/etc would be slick, I think.

@ericholscher
Copy link
Member

Do you have a good project that I could test ASCIIDoc building against? I'd like to try and add this as the first non-sphinx builder backend.

@rphillips
Copy link
Author

the git project uses a lot of asciidoc. http://git.kernel.org/?p=git/git.git;a=summary

@ericholscher
Copy link
Member

As a design decision, we have chosen to invest heavily in Sphinx, and not support other backends. This would complicate a lot of things, and I want to have RTD act as a way to evangelize Sphinx. Having the code base support other backends would be easy, and is lightly documented here: http://read-the-docs.readthedocs.org/en/latest/builds.html#writing-your-own-builder

I would accept code into the code base to allow this, but the readthedocs.org instance of the code base will focus on Sphinx.

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

No branches or pull requests

2 participants