Skip to content

Commit

Permalink
Fix issue #2 (#3)
Browse files Browse the repository at this point in the history
* Update pyproject.toml

* Delete read.py

* Fix issue #2
  • Loading branch information
dchassin authored Oct 2, 2024
1 parent c1b2a1a commit 2c54c59
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 27 deletions.
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,11 @@ <h3 class="w3-container">Returns</h3>
</ul>
<h3 class="w3-container">Properties</h3>
<ul><li><code>DEBUG (bool)</code>: enable debugging traceback on exception</li>
<li><code>WITHCSS (str)</code>: enable copying CSS file to `docs/`</li>
<li><code>WITHCSS (str)</code>: enable copying CSS file to <code>docs/</code></li>
</li>
</ul>
<h3 class="w3-container">Exceptions</h3>
<ul><li><code>Exception</code>: exceptions are only raised if `DEBUG` is `True`.</li>
<ul><li><code>Exception</code>: exceptions are only raised if <code>DEBUG</code> is <code>True</code>.</li>
<li><code>FileNotFoundError</code>: exception raised when an input file is not found.</li>
<li><code>QdoxError</code>: exception raised when an invalid command argument is encountered.</li>
</li>
Expand All @@ -120,7 +120,7 @@ <h2 class="w3-container">Python Constants</h2><p/><code>E_ERROR = 1</code><p/><c
<h1 id="package" class="w3-container">Package Metadata</h1>
<p/><table class="w3-container">
<tr><th><nobr>Name</nobr></th><td>:</td><td>qdox</td></tr>
<tr><th><nobr>Version</nobr></th><td>:</td><td>0.0.0a0</td></tr>
<tr><th><nobr>Version</nobr></th><td>:</td><td>0.0.0a1</td></tr>
<tr><th><nobr>Description</nobr></th><td>:</td><td>Generate quick documentation for a Python project on GitHub</td></tr>
<tr><th><nobr>Authors</nobr></th><td>:</td><td>David P. Chassin <dpchassin@gmail.com></td></tr>
<tr><th><nobr>Maintainers</nobr></th><td>:</td><td>David P. Chassin <dpchassin@gmail.com></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ py-modules = []

[project]
name = "qdox"
version = "0.0.0a0"
version = "0.0.0a1"
description = "Generate quick documentation for a Python project on GitHub"
authors = [
{name = "David P. Chassin <[email protected]>"},
Expand Down
9 changes: 5 additions & 4 deletions qdox.py
Original file line number Diff line number Diff line change
Expand Up @@ -372,17 +372,18 @@ def get_mode():
write_html("<p/>")
elif line.startswith(" ") and line.strip().endswith(":"):
set_mode(None)
write_html(f"""<h3 class="w3-container">{line.strip()[:-1]}</h3>\n""")
write_html(f"""<h3 class="w3-container">{line.strip()[:-1]}</h3>""",nl=True)
elif line.startswith(" "):
set_mode("ul")
part = line.strip().split(":",1)
if len(part) == 2:
write_html(f"<li><code>{part[0]}</code>: {part[1]}</li>\n",md=False)
write_html(f"<li><code>{part[0]}</code>: ",md=False,nl=False)
write_html(f"{part[1]}</li>",nl=True)
else:
write_html(f"<li>{part[0]}</li>\n",md=False)
write_html(f"<li>{part[0]}</li>",md=True,nl=True)
else:
set_mode(None)
write_html(f"{line}\n")
write_html(f"{line}",md=True,nl=True)
else:
print(f"WARNING: function '{name}' has no __doc__")
set_mode(None)
Expand Down
19 changes: 0 additions & 19 deletions read.py

This file was deleted.

0 comments on commit 2c54c59

Please sign in to comment.