Added API_README to docs (#1146)

Author: RhetTbull

API_README.md

@@ -57,11 +57,12 @@ osxphotos provides several useful helper functions to make it easy to build simp
 Here's a simple example showing how to use the `query_command` decorator to implement a simple command line tool. The `query_command` decorator turns your function into a full-fledged [Click](https://palletsprojects.com/p/click/) command line app that can be run via `osxphotos run example.py` or `python example.py` if you have pip installed osxphotos.  Your command will include all the query options available in `osxphotos query` as command line options as well as `--verbose` and other convenient options.
 
 <!--[[[cog
-cog.out("```python\n")
+cog.out("\n```python\n")
 with open("examples/cli_example_1.py", "r") as f:
     cog.out(f.read())
 cog.out("```\n")
 ]]]-->
+
 ```python
 """Sample query command for osxphotos
 
@@ -136,11 +137,12 @@ if __name__ == "__main__":
 Here is a more advanced example that shows how to implement a script with a "dry run" and "resume" capability that preserves state between runs. Using the built-in helpers allows you to implement complex behavior in just a few lines of code.
 
 <!--[[[cog
-cog.out("```python\n")
+cog.out("\n```python\n")
 with open("examples/cli_example_2.py", "r") as f:
     cog.out(f.read())
 cog.out("```\n")
 ]]]-->
+
 ```python
 """Sample query command for osxphotos
 
@@ -308,11 +310,12 @@ if __name__ == "__main__":
 In addition to the `query_command` decorator, you can also use the `selection_command` decorator to implement a command that operates on the current selection in Photos.
 
 <!--[[[cog
-cog.out("```python\n")
+cog.out("\n```python\n")
 with open("examples/cli_example_3.py", "r") as f:
     cog.out(f.read())
 cog.out("```\n")
 ]]]-->
+
 ```python
 """Sample query command for osxphotos
 
@@ -2242,8 +2245,9 @@ To get the path of every raw photo, whether it's a single raw photo or a raw+JPE
 
 <!--[[[cog
 from osxphotos.phototemplate import get_template_help
-cog.out(get_template_help())
+cog.out("\n"+get_template_help())
 ]]]-->
+
 <!-- Generated by cog: see phototemplate.cog.md -->
 
 The templating system converts one or template statements, written in osxphotos metadata templating language, to one or more rendered values using information from the photo being processed.
@@ -2408,8 +2412,9 @@ The following template field substitutions are availabe for use the templating s
 
 <!--[[[cog
 from osxphotos.phototemplate import get_template_field_table
-cog.out(get_template_field_table())
+cog.out("\n"+get_template_field_table()+"\n")
 ]]]-->
+
 | Field | Description |
 |--------------|-------------|
 |{name}|Current filename of the photo|

README.md

@@ -1448,8 +1448,18 @@ Options:
                                   full path of all exported files to the file
                                   'exported.txt'. You can run more than one
                                   command by repeating the '--post-command'
-                                  option with different arguments. See Post
-                                  Command below.
+                                  option with different arguments. See also
+                                  --post-command-error and --post-function.See
+                                  Post Command below.
+  --post-command-error ACTION     Specify either `continue` or `break` for
+                                  ACTION to control behavior when a post-command
+                                  fails. If `continue`, osxphotos will log the
+                                  error and continue processing. If `break`,
+                                  osxphotos will stop processing any additional
+                                  --post-command commands for the current photo
+                                  but will continue with the export. Without
+                                  --post-command-error, osxphotos will abort the
+                                  export if a post-command encounters an error.
   --post-function filename.py::function
                                   Run function on exported files. Use this in
                                   format: --post-function filename.py::function

build.sh

@@ -30,6 +30,12 @@ python3 utils/generate_template_docs.py
 m2r2 docsrc/source/template_help.md
 rm docsrc/source/template_help.md
 
+echo "Copying API_README.md to docsrc/source/api_readme.md"
+rm docsrc/source/api_readme.rst
+cp API_README.md docsrc/source/api_readme.md
+m2r2 docsrc/source/api_readme.md
+rm docsrc/source/api_readme.md
+
 # build docs
 echo "Building docs"
 (cd docsrc && make github && make pdf)