22 Commits
Author SHA1 Message Date
Elliot Jordan 8fa4a6689a Automatically rebuild processor wiki pages upon creation of new GitHub tags (#844)
* Raise specific import errors

* Enable non-interactive script run

* Add note about processor docs generation

* Rebuild processor docs upon new tag creation

* Support using existing clone (for GH actions workflow)
2022-11-26 12:55:13 -08:00
Elliot Jordan 577e0bef22 Avoid trailing dots when printing paths 2021-11-11 12:24:52 -08:00
Elliot Jordan 6591e57758 Allow skipping of experimental processors 2021-11-11 12:24:52 -08:00
Elliot Jordan 33e91e281f Resolve issue producing binary text output on wiki 2021-11-11 12:24:52 -08:00
Nick McSpadden 03d1bfafd2 Changing python interpreter path to /usr/local/autopkg/python 2019-11-06 14:38:50 -08:00
Nick McSpadden fa40e86909 Updating autopkg scripts 2019-11-04 09:05:47 -08:00
Nick McSpadden 60fd0fcdde Extra isort run 2019-10-29 14:55:06 -07:00
Nick McSpadden f1314c081c Py2-to-3 conversion 2019-10-24 16:23:20 -07:00
Michal Moravec 81aed1464c Fix isort errors (#536) 2019-06-11 08:06:30 -07:00
Nick McSpadden 29cbe1c0ca Blackening all Python code (#526) 2019-05-17 12:26:25 -07:00
Nick McSpadden 91278f33af Adding a per-processor option to generate_processor_docs (#524) 2019-05-17 06:14:10 -07:00
Nick McSpadden 49ac6f6f4d Moving sidebar into separate function (#523)
Separate out some of the existing functionality into smaller functions, for added testability in the future.
2019-05-16 14:31:45 -07:00
Greg Neagle 7638c1900f Change sorting of processor names to case-insensitive to better match HFS+ os.listdir() behavior. 2019-05-12 09:50:13 -07:00
Nick McSpadden 2160697934 generate_processor_docs sorts the sidebar alphabetically (#520)
* generate_processor_docs with flake8+isort

* Also change ''' to """

* Fixing the import dependencies being broken by isort

The import order in this case is dependent on loading files into the path, and using imp to load a source file directly.

To address this, the imports are wrapped in a try/except and will simply exit 1 if they don't function. This allows the order dependencies to exist without letting isort break them.

* Ensure sidebar is sorted when generating docs

```
diff --git a/_Sidebar.md b/_Sidebar.md
index 1715e7b..75b75c6 100644
--- a/_Sidebar.md
+++ b/_Sidebar.md
@@ -29,10 +29,10 @@
       * [[AppDmgVersioner|Processor-AppDmgVersioner]]
       * [[AppPkgCreator|Processor-AppPkgCreator]]
       * [[BrewCaskInfoProvider|Processor-BrewCaskInfoProvider]]
-      * [[CodeSignatureVerifier|Processor-CodeSignatureVerifier]]
-      * [[Copier|Processor-Copier]]
       * [[CURLDownloader|Processor-CURLDownloader]]
       * [[CURLTextSearcher|Processor-CURLTextSearcher]]
+      * [[CodeSignatureVerifier|Processor-CodeSignatureVerifier]]
+      * [[Copier|Processor-Copier]]
       * [[DmgCreator|Processor-DmgCreator]]
       * [[DmgMounter|Processor-DmgMounter]]
       * [[EndOfCheckPhase|Processor-EndOfCheckPhase]]
@@ -42,8 +42,8 @@
       * [[FlatPkgPacker|Processor-FlatPkgPacker]]
       * [[FlatPkgUnpacker|Processor-FlatPkgUnpacker]]
       * [[GitHubReleasesInfoProvider|Processor-GitHubReleasesInfoProvider]]
-      * [[Installer|Processor-Installer]]
       * [[InstallFromDMG|Processor-InstallFromDMG]]
+      * [[Installer|Processor-Installer]]
       * [[MunkiCatalogBuilder|Processor-MunkiCatalogBuilder]]
       * [[MunkiImporter|Processor-MunkiImporter]]
       * [[MunkiInfoCreator|Processor-MunkiInfoCreator]]
@@ -63,9 +63,9 @@
       * [[SparkleUpdateInfoProvider|Processor-SparkleUpdateInfoProvider]]
       * [[StopProcessingIf|Processor-StopProcessingIf]]
       * [[Symlinker|Processor-Symlinker]]
-      * [[Unarchiver|Processor-Unarchiver]]
       * [[URLDownloader|Processor-URLDownloader]]
       * [[URLTextSearcher|Processor-URLTextSearcher]]
+      * [[Unarchiver|Processor-Unarchiver]]
       * [[Versioner|Processor-Versioner]]
   * **Development**
-      * [[Packaging releases on GitHub|Packaging-AutoPkg-For-Release-on-GitHub]]
\ No newline at end of file
+      * [[Packaging releases on GitHub|Packaging-AutoPkg-For-Release-on-GitHub]]
```
2019-05-12 09:26:14 -07:00
Nick McSpadden 3855fabd17 generate_processor_docs with flake8+isort (#517)
* generate_processor_docs with flake8+isort

* Also change ''' to """

* Fixing the import dependencies being broken by isort

The import order in this case is dependent on loading files into the path, and using imp to load a source file directly.

To address this, the imports are wrapped in a try/except and will simply exit 1 if they don't function. This allows the order dependencies to exist without letting isort break them.
2019-05-10 21:41:51 -07:00
Timothy Sutton eda6908db6 Update Processor Reference heading for wiki docs 2014-12-09 15:23:25 -05:00
Greg Neagle ed9a9d721a Pylint cleanups for Scripts/generate_processor_docs.py 2014-08-11 17:10:20 -07:00
Greg Neagle 106fe748c2 Remove all trailing whitespace from Scripts/*.py files 2014-08-06 15:37:54 -07:00
Greg Neagle 7a8df0ba00 Change 'shebang' line in all Python files to ensure we attempt to use the system Python and not some other Python the user might have installed. 2014-08-02 12:19:10 -07:00
Timothy Sutton bfe00ee88e Docs generation script: require version number an argument
- eliminates the need to run the script when the tree is at a particular version
2014-07-24 13:26:59 -04:00
Timothy Sutton 766603febf Missed comma in processor Wiki docs push 2014-05-20 09:46:43 -04:00
Timothy Sutton 79cdbc7025 processor wiki docs generation now one self-contained script
- moved to Scripts
- script now performs the git clone, commit, diff and optional push
- no manual steps required
2014-05-08 10:57:19 -04:00