gernot
/
pEpDocumentation
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
provide python scripts to deploy autogenerated documentation online
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
25 Commits
1 Branch
0 Tags
75 KiB
 
Tag: Branch: Tree: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Gernot Kranz 696ad65268
Layout change 		9 months ago
.gitignore first commit 9 months ago
DoxygenLayout.xml Layout change 9 months ago
README.md README appended 9 months ago
doc-demo.py Updatng demo script 9 months ago
doc.py Even more restrictive config for public doc 9 months ago

README.md

pEpDocumentation

Provides python3 scripts to deploy autogenerated API documentation online.

doc.py

Usage: python3 doc.py <pEpProject> <ReleaseTag> [--doxyfile <Doxyfile>] [<Options>]

where:

  • <pEpProject> is a Repository Name of a pEp Project (eg "pEpEngine")
  • <ReleaseTag> is a ReleaseTag (or a branch) of this repo and
  • <Doxyfile> is a path relative to that points to the Doxyfile. This defaults to src/Doxyfile.
  • <Options> is one of
    • -h: Print a usage message and exit
    • -v: Be verbose and don't suppress output by make and doxygen