Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python Client API section in markdown has HTML tags #4152

Open
klvbdmh opened this issue Nov 26, 2024 · 0 comments
Open

Python Client API section in markdown has HTML tags #4152

klvbdmh opened this issue Nov 26, 2024 · 0 comments
Labels
amalgamation build Issues related to the documentation's amalgamation build (single-file Markdown/PDF) python [component] Python API

Comments

@klvbdmh
Copy link

klvbdmh commented Nov 26, 2024

When I access the markdown documentation at https://duckdb.org/duckdb-docs.md, the Python Client API section has HTML tags. It makes it hard to read.

Example:

### Python Client API {#docs:api:python:reference:index}

<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<dl class="py data" id="module-duckdb">
<dt class="sig sig-object py" id="duckdb.threadsafety">
<span class="sig-prename descclassname"><span class="pre">duckdb.</span></span><span class="sig-name descname"><span class="pre">threadsafety</span></span><em class="property"><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#duckdb.threadsafety" title="Link to this definition">&#182;</a>
</dt>
<dd>
<p>Indicates that this package is threadsafe</p>
</dd>
</dl>

<dl class="py data">
<dt class="sig sig-object py" id="duckdb.apilevel">
<span class="sig-prename descclassname"><span class="pre">duckdb.</span></span><span class="sig-name descname"><span class="pre">apilevel</span></span><em class="property"><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#duckdb.apilevel" title="Link to this definition">&#182;</a>
</dt>
<dd>
<p>Indicates which Python DBAPI version this package implements</p>
</dd>
</dl>

<dl class="py data">
<dt class="sig sig-object py" id="duckdb.paramstyle">
<span class="sig-prename descclassname"><span class="pre">duckdb.</span></span><span class="sig-name descname"><span class="pre">paramstyle</span></span><em class="property"><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#duckdb.paramstyle" title="Link to this definition">&#182;</a>
</dt>
<dd>
<p>Indicates which parameter style duckdb supports</p>
</dd>
</dl>

[...]
@szarnyasg szarnyasg added the amalgamation build Issues related to the documentation's amalgamation build (single-file Markdown/PDF) label Dec 4, 2024
@szarnyasg szarnyasg added the python [component] Python API label Mar 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
amalgamation build Issues related to the documentation's amalgamation build (single-file Markdown/PDF) python [component] Python API
Projects
None yet
Development

No branches or pull requests

2 participants