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.1.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: docs_to_md-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 6201162c3e8ff62fa5973798b3870d4c885a05cfbafb1960f1e9b33454617f20
MD5 7dfc81eb9d06a57b8ae0745ba35275e5
BLAKE2b-256 77724dcc4cc796d73cc5de2bb8d4c914353ddae194fd45ee2f71639209ef182f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docs_to_md-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd00ca84c9ad1a8f88aab61634401c3d70609d07a0da4f9ece354ab1a1c5c730
MD5 e83e5af60b0c018c26eee551852506a2
BLAKE2b-256 3b6652a540169b94fc8ec2d5a57a646cad1e448c7ce7b9fa93dd0c5c0d94d8b4

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