Giter Club home page Giter Club logo

Comments (5)

tony avatar tony commented on June 14, 2024 10

I got here via Google. I was expecting to see the opposite: "Move website from sphinx to Docusaurus". I'm surprised.

I'm a python programmer that uses sphinx-doc on 10+ websites (including API generation). I prefer markdown.

One area where Sphinx is strong is API documentation. I haven't been able to find a suitable alternative.

https://tmuxp.git-pull.com - example of a sphinx site, and recently a docusaurus v2 website: https://social-embed.git-pull.com

I loved building with docusaurus. I dread having to open up sphinx. Sphinx used to be the "go to" choice for customization. With gatsby/next/docusaurus and SSR, the case for sphinx-doc is weaker. Still - none of my python projects use it :/

I'd like to drop a link, while I haven't tried yet: https://pydoc-markdown.readthedocs.io/en/latest/docs/renderers/docusaurus-v2/

from texthero.

astrojuanlu avatar astrojuanlu commented on June 14, 2024 1

Also arrived here from Google and also surprised 🙃

I'm a python programmer that uses sphinx-doc on 10+ websites (including API generation). I prefer markdown.

You can write Markdown in Sphinx: https://myst-parser.readthedocs.io/

from texthero.

avinashbhat avatar avinashbhat commented on June 14, 2024

@jbesomi I see this issue being referenced multiple times so I'm guessing this is one of the priority items. Can I help with this or is this taken up by someone already?
I am a beginner on Sphinx, but with some pointers, I can probably work on the task.

from texthero.

jbesomi avatar jbesomi commented on June 14, 2024

Hey @avinashbhat, sorry for my late reply.

Absolutely, this is quite first priority. And no, nobody already took it. Do you want to start and see how it goes? Is the task clear?

from texthero.

MasterMedo avatar MasterMedo commented on June 14, 2024

I'm also switching from sphinx to docusaurus. pydoc-markdown + docusaurus renderer is exactly what I was searching for. Thanks, @tony.

from texthero.

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.