sphinx

Really weird to see this person mention MyST as a form of Markdown, and then go on to talk about reStructuredText as their first example of a markup language "that gives you more control over structure than ... markdown". The whole point of MyST is to provide a markdown-like alternative to rST. It literally has directives, roles, structural semantics, etc. It just doesn't have the unlearnable syntax of rST and the so-called governance of docutils (the de facto rST parser) (see e.g. discussion on https://github.com/sphinx-doc/sphinx/issues/8039 and linking issues)

Pagefind: https://pagefind.app/ .. https://github.com/pagefind/pagefind : > The goal of Pagefind is that websites with tens of thousands of pages should be searchable by someone in their browser, while consuming as little bandwidth as possible. Pagefind’s search index is split into chunks, so that searching in the browser only ever needs to load a small subset of the search index. Pagefind can run a full-text search on a 10,000 page site with a total network payload under 300kB, including the Pagefind library itself. From https://news.ycombinator.com/item?id=31321024 : > Sphinx searchindex.js does Porter stemming for English and other languages: [ sphinx.search: https://github.com/sphinx-doc/sphinx/tree/master/sphinx/sear... ] atsphinx/pagefind adds pagefind search to sphinx docs : https://github.com/atsphinx/pagefind

It works with all docutils and Sphinx roles, and almost all directives, including extensions. A notable exception is autodoc (automodule, autoclass, etc.), and any other directives that generate more rST. The current workaround is to use eval-rst: https://myst-parser.readthedocs.io/en/latest/syntax/code_and... Some more discussion about that in these issues: https://github.com/executablebooks/MyST-Parser/issues/163 https://github.com/sphinx-doc/sphinx/issues/8018

The `pydoc` / `python -m pydoc` module doesn't do search; it would be O(n) for every search like grep without e.g. a sphinx searchindex: https://docs.python.org/3/library/pydoc.html Sphinx searchindex.js does Porter stemming for English and other languages: https://github.com/sphinx-doc/sphinx/blob/5.x/sphinx/search/... sphinxcontrib.websupport.search supports Xapian, Whoosh (Python), and null: https://github.com/sphinx-doc/sphinxcontrib-websupport/blob/... sphinx-elasticsearch https://github.com/zeitonline/sphinx_elasticsearch : > This is a stand-alone extraction of the functionality used by readthedocs.org, compatible with elasticsearch-6. MeiliSearch (rust) compared with ElasticSearch (java), Algolia, TypeSense (C++): https://docs.meilisearch.com/learn/what_is_meilisearch/compa... Is there a good way to index each sphinx doc set's s

Why use this over something like sphinx[1], which has quite a rich and established ecosystem? Combine with Furo[2] and it even looks quite similar. [1] https://github.com/sphinx-doc/sphinx [2] https://github.com/pradyunsg/furo

You can start porting your live codebase to python 3 right now - no downtime at all. You can have a 2+3 compatible codebase live in a week or two, it'll get you about 98% the way there [1] My projects (e.g. https://tmuxp.git-pull.com, https://unihan-etl.git-pull.com) are both python 2/3 compatible. I learned by reading through other projects like Sphinx, Flask, Werkzeug, and SQLAlchemy: - Flask: https://github.com/pallets/flask - Werkzeug: https://github.com/pallets/werkzeug - Sphinx https://github.com/sphinx-doc/sphinx/tree/v1.8.5 (see compat: https://github.com/sphinx-doc/sphinx/blob/v1.8.5/sphinx/util...) - https://github.com/sqlalchemy/sqlalchemy Helpful blog posts: http://lucumr.pocoo.org/2011/1/22/forwards-compatible-python..., http://lucumr.pocoo.org/2013/5/21/porting-to-python-3-redux/ As for automation tools, for 2/3 compatibili

Sphinx is very powerful, I recommend it. https://github.com/sphinx-doc/sphinx

Dropbox and Instagram use mypy/typing actively. Also among open-source: https://github.com/home-assistant/home-assistant https://github.com/mitmproxy/mitmproxy https://github.com/sphinx-doc/sphinx I would say the opposite, it is not very useful for small projects.

First, there is commonmark that is trying to standardize markdown. There is also recommonmark which will parse commonmark for sphinx: https://github.com/rtfd/recommonmark However, commonmark currently lack support for tables, so I fall back on rst for tables(actually I think the syntax for tables in rst is much better than tables in other markdown flavors). Also, resolving links using commonmark in sphinx is a mess, right now. I actually extended recommonmark so sphinx will properly resolve cross references(including reference to elements in a domain). However, I had to update sphinx as well, which I have a PR open with no response from them, here: https://github.com/sphinx-doc/sphinx/pull/2644 It seems unfortunate that sphinx devs are unresponsive to contributions. The devs for mkdocs are a lot more responsive, but seem more interested i

MkDocs (http://mkdocs.org) or Sphinx (https://github.com/sphinx-doc/sphinx) along with ReadTheDocs (https://readthedocs.org). I've also used Confluence and a few other tools. These are my preferences though. What are you looking to accomplish?