-
Notifications
You must be signed in to change notification settings - Fork 794
updatingDocumentation
- summary Information about updating the PMTK3 documentation
_*Most of these scripts rely on hard coded, user dependent paths set in the config.txt file; make sure these are correct before running the scripts. If you have a config-local.txt file, any listed property value pairs override those in config.txt.*_
|| publishDemos || This script should be run overnight as it can take several hours to complete. It updates [Demos] and republishes all of the demos. If you only want to regenerate the tables, and not rerun the demos (thus taking only a minute), set wikiOnly to true at the top of the file. This script interacts with PML to determine on which pages in the book the demos are referenced. PML must be fully compiled. publishDemos calls the publishFolder function to publish each demo folder. You can use this to republish a single folder; see it for additional defaults such as tag based exclusions. If the demos directory structure has changed significantly, delete the contents of docs/demoOutput first.|| || generateAuthorReport || This script takes about 30 seconds to run, and generates this table of contributed files. || || generateAuthorLocReport || This script takes about 30 seconds to run, and generates this table, showing the lines of code contributed by various authors. || || generateSupportReport || This script takes only a few seconds to run, and generates this table of supporting packages. You must have a local copy of the pmtkSupport svn repository. The html report is stored in the pmtkSupport repository. See this page for details on adding and updating packages.|| ||generatePmtkStats || This script takes about 30 seconds to run, and generates this table. || ||generateSynopses || This script takes about 10 seconds to run, and generates [synopsisPages]. || ||generatePmtkDataTable || This script about 30 seconds to run, generating this table. You must have a local copy of the pmtkData svn repository. The html table is stored in the pmtkData repository. See this page for details on adding new data sets.|| ||debugDemos || debugDemos runs most of the demos, capturing warnings and errors along the way. Figures generated by these demos are not displayed. The scripts runs in about 20 minutes depending on the exclusion tags at the top of the file. You must always exclude PMTKinteractive. It generates this table . || || pmlMissingCodeReport || This script generates an html table of code referenced in PML that can not be found. It includes the page numbers on which the code is referenced. Like publishDemos above, this script uses pmlChapterPages, and pmlCodeRefs to parse the latex code.ind, and pml.toc files. PML must be fully compiled. || ||pmlUnusedDemoReport || This script generates a list of all PMTK3 demos that are not referenced in PML. It has the same requirements as pmlMissingCodeReport above. || || pmlFigureCodeReport|| This takes a few minutes to run and generates an html table of all of the figures in PML along with links to the images and source files. PML must not have any syntax errors, (i.e. it must be compilable) and all figures in the book must be added using the \add*fig(s) macros, (otherwise the numbering gets thrown off). Missing source files are also recorded, and the above pmlMissingCodeReport is also called. All files are packed up into a new directory structure. || || generateModelsVsMethodsTables || This script takes about 30 seconds to run and generates [ModelsByMethods] showing PMTK models and the methods they support. It works by searching for PMTKsimpleModel, PMTKlatentModel, PMTKsupervisedModel, and PMTKgraphicalModel tags in files. List the model name after each tag, as in . ||
publishDemos, and generateSynopses both update their respective wiki pages automatically. For this to work, you need to have a locally checked out copy of the wiki branch of the svn repository. Remember to check in changes made to this local wiki repository after running these scripts.
_All of these scripts require Matlab, and will not work under Octave._