Skip to content

Commit

Permalink
Example formatting tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
Garth Minette committed Feb 19, 2021
1 parent fe93c5d commit 7860af6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
OpenSCAD Documentation Generator
################################

This package generates wiki-ready markdown documentation pages from in-line source code comments.
This is similar to Doxygen or JavaDoc, but designed for use with OpenSCAD code. Example images
can be generated automatically from short example scripts.
This package generates wiki-ready GitHub flavored markdown documentation pages from in-line source
code comments. This is similar to Doxygen or JavaDoc, but designed for use with OpenSCAD code.
Example images can be generated automatically from short example scripts.

Documentation about how to add documentation comments to OpenSCAD code can be found at
`https://github.com/revarbat/openscad_docsgen/blob/main/WRITING_DOCS.rst`
Expand Down
11 changes: 6 additions & 5 deletions openscad_docsgen/blocks.py
Original file line number Diff line number Diff line change
Expand Up @@ -437,13 +437,8 @@ def get_markdown(self):
return out
out.append("**{}:** {}".format(mkdn_esc(self.title), mkdn_esc(self.subtitle)))
out.append("")
if "Figure" not in self.title:
out.extend([" " + line for line in fileblock.includes])
out.extend([" " + line for line in self.body if not line.strip().startswith("--")])
out.append("")
if "NORENDER" not in self.meta and self.image_url:
out.append(
#"![{0} {1}{2}]({3})"
'<img align="left" alt="{0} {1}{2}" src="{3}">'
.format(
mkdn_esc(self.parent.subtitle),
Expand All @@ -453,6 +448,12 @@ def get_markdown(self):
)
)
out.append("")
if "Figure" not in self.title:
out.extend([" " + line for line in fileblock.includes])
out.extend([" " + line for line in self.body if not line.strip().startswith("--")])
out.append("")
out.append('<br clear="all" />')
out.append("")
return out


Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

from setuptools import setup

VERSION = "1.0.2"
VERSION = "1.0.3"


with open('README.rst') as f:
Expand All @@ -19,7 +19,7 @@
author='Revar Desmera',
author_email='[email protected]',
url='https://github.com/revarbat/openscad_docsgen',
download_url='https://github.com/revarbat/openscad_docsgen/archive/v1.0.2.zip',
download_url='https://github.com/revarbat/openscad_docsgen/archive/v1.0.3.zip',
packages=['openscad_docsgen'],
license='MIT License',
classifiers=[
Expand Down

0 comments on commit 7860af6

Please sign in to comment.