mirror of
https://github.com/nophead/NopSCADlib.git
synced 2025-08-01 13:10:11 +02:00
Single backtick now used for all code quotes.
This commit is contained in:
@@ -36,7 +36,7 @@ def doc_scripts():
|
||||
print(
|
||||
'''
|
||||
# Python scripts
|
||||
These are located in the ```scripts``` subdirectory, which needs to be added to the program search path.
|
||||
These are located in the `scripts` subdirectory, which needs to be added to the program search path.
|
||||
|
||||
They should work with both Python 2 and Python 3.
|
||||
|
||||
@@ -60,7 +60,7 @@ They should work with both Python 2 and Python 3.
|
||||
break
|
||||
if not blurb:
|
||||
print("Missing description for", file)
|
||||
print("| ```%s``` | %s |" % (file, blurb), file = doc_file)
|
||||
print("| `%s` | %s |" % (file, blurb), file = doc_file)
|
||||
|
||||
with open(dir + "/readme.html", "wt") as html_file:
|
||||
do_cmd(("python -m markdown -x tables " + doc_name).split(), html_file)
|
||||
|
@@ -18,7 +18,7 @@
|
||||
# You should have received a copy of the GNU General Public License along with NopSCADlib.
|
||||
# If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
#! Generates all the files for a project by running ```bom.py```, ```stls.py```, ```dxfs.py```, ```render.py``` and ```views.py```.
|
||||
#! Generates all the files for a project by running `bom.py`, `stls.py`, `dxfs.py`, `render.py` and `views.py`.
|
||||
|
||||
import sys
|
||||
|
||||
|
@@ -18,7 +18,7 @@
|
||||
# You should have received a copy of the GNU General Public License along with NopSCADlib.
|
||||
# If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
#! Panelises DXF files so they can be routed together by running scad files found in the ```panels``` directory.
|
||||
#! Panelises DXF files so they can be routed together by running scad files found in the `panels` directory.
|
||||
|
||||
from __future__ import print_function
|
||||
import sys
|
||||
|
@@ -18,7 +18,7 @@
|
||||
# You should have received a copy of the GNU General Public License along with NopSCADlib.
|
||||
# If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
#! Generates build plates of STL files for efficient printing by running scad files found in the ```platters``` directory.
|
||||
#! Generates build plates of STL files for efficient printing by running scad files found in the `platters` directory.
|
||||
|
||||
from __future__ import print_function
|
||||
import sys
|
||||
|
@@ -1,22 +1,24 @@
|
||||
|
||||
# Python scripts
|
||||
These are located in the ```scripts``` subdirectory, which needs to be added to the program search path.
|
||||
These are located in the `scripts` subdirectory, which needs to be added to the program search path.
|
||||
|
||||
They should work with both Python 2 and Python 3.
|
||||
|
||||
| Script | Function |
|
||||
|:---|:---|
|
||||
| ```bom.py``` | Generates BOM files for the project. |
|
||||
| ```c14n_stl.py``` | OpenSCAD produces randomly ordered STL files. This script re-orders them consistently so that GIT can tell if they have changed or not. |
|
||||
| ```doc_scripts.py``` | Makes this document and doc/usage.md. |
|
||||
| ```dxfs.py``` | Generates DXF files for all the routed parts listed on the BOM or a specified list. |
|
||||
| ```gallery.py``` | Finds projects and adds them to the gallery. |
|
||||
| ```make_all.py``` | Generates all the files for a project by running ```bom.py```, ```stls.py```, ```dxfs.py```, ```render.py``` and ```views.py```. |
|
||||
| ```panels.py``` | Panelises DXF files so they can be routed together by running scad files found in the ```panels``` directory. |
|
||||
| ```platters.py``` | Generates build plates of STL files for efficient printing by running scad files found in the ```platters``` directory. |
|
||||
| ```render.py``` | Renders STL and DXF files to PNG for inclusion in the build instructions. |
|
||||
| ```set_config.py``` | Sets the target configuration for multi-target projects that have variable configurations. |
|
||||
| ```stls.py``` | Generates STL files for all the printed parts listed on the BOM or a specified list. |
|
||||
| ```svgs.py``` | Generates SVG files for all the routed parts listed on the BOM or a specified list. |
|
||||
| ```tests.py``` | Runs all the tests in the tests directory and makes the readme file with a catalog of the results. |
|
||||
| ```views.py``` | Generates exploded and unexploded assembly views and scrapes build instructions to make readme.md, readme.html and printme.html files for the project. |
|
||||
| `bom.py` | Generates BOM files for the project. |
|
||||
| `c14n_stl.py` | OpenSCAD produces randomly ordered STL files. This script re-orders them consistently so that GIT can tell if they have changed or not. |
|
||||
| `doc_scripts.py` | Makes this document and doc/usage.md. |
|
||||
| `dxf.py` | |
|
||||
| `dxf2pdf.py` | |
|
||||
| `dxfs.py` | Generates DXF files for all the routed parts listed on the BOM or a specified list. |
|
||||
| `gallery.py` | Finds projects and adds them to the gallery. |
|
||||
| `make_all.py` | Generates all the files for a project by running `bom.py`, `stls.py`, `dxfs.py`, `render.py` and `views.py`. |
|
||||
| `panels.py` | Panelises DXF files so they can be routed together by running scad files found in the `panels` directory. |
|
||||
| `platters.py` | Generates build plates of STL files for efficient printing by running scad files found in the `platters` directory. |
|
||||
| `render.py` | Renders STL and DXF files to PNG for inclusion in the build instructions. |
|
||||
| `set_config.py` | Sets the target configuration for multi-target projects that have variable configurations. |
|
||||
| `stls.py` | Generates STL files for all the printed parts listed on the BOM or a specified list. |
|
||||
| `svgs.py` | Generates SVG files for all the routed parts listed on the BOM or a specified list. |
|
||||
| `tests.py` | Runs all the tests in the tests directory and makes the readme file with a catalog of the results. |
|
||||
| `views.py` | Generates exploded and unexploded assembly views and scrapes build instructions to make readme.md, readme.html and printme.html files for the project. |
|
||||
|
@@ -219,7 +219,7 @@ def tests(tests):
|
||||
if things:
|
||||
body += ['### %s\n| %s | Description |\n|:--- |:--- |' % (thing.title(), heading)]
|
||||
for item in sorted(things):
|
||||
body += ['| ```%s``` | %s |' % (item, things[item])]
|
||||
body += ['| `%s` | %s |' % (item, things[item])]
|
||||
body += ['']
|
||||
|
||||
body += ["\n" %(base_name, png_name)]
|
||||
@@ -252,7 +252,7 @@ def tests(tests):
|
||||
desc = ''
|
||||
if thing == "vitamins":
|
||||
vit = item.split(':')
|
||||
name = '```' + vit[0] + '```' if vit[0] else ''
|
||||
name = '`' + vit[0] + '`' if vit[0] else ''
|
||||
while '[[' in name and ']]' in name:
|
||||
i = name.find('[[')
|
||||
j = name.find(']]') + 2
|
||||
|
Reference in New Issue
Block a user