Giter Club home page Giter Club logo

Comments (8)

ericholscher avatar ericholscher commented on July 24, 2024

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.

from readthedocs.org.

ericholscher avatar ericholscher commented on July 24, 2024

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.

from readthedocs.org.

rphillips avatar rphillips commented on July 24, 2024

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

from readthedocs.org.

ericholscher avatar ericholscher commented on July 24, 2024

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

from readthedocs.org.

rphillips avatar rphillips commented on July 24, 2024

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.

from readthedocs.org.

ericholscher avatar ericholscher commented on July 24, 2024

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.

from readthedocs.org.

rphillips avatar rphillips commented on July 24, 2024

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

from readthedocs.org.

ericholscher avatar ericholscher commented on July 24, 2024

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.

from readthedocs.org.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.