diff --git a/README.rst b/README.rst index 26d4741..98c218f 100644 --- a/README.rst +++ b/README.rst @@ -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` diff --git a/openscad_docsgen/blocks.py b/openscad_docsgen/blocks.py index 09e721c..a1189d4 100644 --- a/openscad_docsgen/blocks.py +++ b/openscad_docsgen/blocks.py @@ -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})" '{0} {1}{2}' .format( mkdn_esc(self.parent.subtitle), @@ -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('
') + out.append("") return out diff --git a/setup.py b/setup.py index a6f41a3..a0f3e4f 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup -VERSION = "1.0.2" +VERSION = "1.0.3" with open('README.rst') as f: @@ -19,7 +19,7 @@ author='Revar Desmera', author_email='revarbat@gmail.com', 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=[