Skip to main content

Convert readthedocs to markdown

Project description

Docs-to-Markdown [D2M]

Docs-to-Markdown is a tool to convert readthedocs project to markdown.

Usage

pip install docs-to-md
d2m --url [target_url]

example:

# use jina api
d2m -u https://example-sphinx-basic.readthedocs.io/en/latest/ -t saved/demo

# use openai api
# not recommend, seems like ollama reader-lm is not good enough compare to jina api
# make sure you have installed `ollama` and run ollama with `ollama run reader-lm`
d2m -u https://example-sphinx-basic.readthedocs.io/en/latest/ -t saved/demo-local -nj -a http://localhost:11434/v1 -m reader-lm

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docs_to_md-0.1.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

docs_to_md-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file docs_to_md-0.1.0.tar.gz.

File metadata

  • Download URL: docs_to_md-0.1.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for docs_to_md-0.1.0.tar.gz
Algorithm Hash digest
SHA256 14a37cdeaf961402043cf2d77d212bae112347ca5187c71a24dc629e454e5f8e
MD5 5f42c70b4fb8d6957ec0e28fe17de645
BLAKE2b-256 27873f63f9244b42a918dbb84e234d323660db4bfbb9c4d1bf07ccc70bea5eca

See more details on using hashes here.

File details

Details for the file docs_to_md-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: docs_to_md-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for docs_to_md-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39063f41b5e0e34644ac810bd345ff02fd66b9d31a95308b0fa5a67867a77b77
MD5 e7091e4593480edd608c4dd451a0e736
BLAKE2b-256 f2f0444dcdd842ff0bc48943be563d5ca38926c734d481df5b0d88cca0c15895

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page