proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-15 21:09:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add hint about -synopsis.adoc files

Browse Source
This commit is contained in:
Dietmar Maurer 2016-01-05 12:26:10 +01:00
parent a1ada59842
commit 578a3111a3
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.adoc
View File

@ -14,6 +14,15 @@ Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.ebup'). files, or ebook formats ('.ebup').
Autogenerated CLI Command Synopsis
----------------------------------
We generate the command line synopsis for all manual pages
automatically. We can do that, because we have a full declarative
definition of the {pve} API. I added those generated files
('*-synopsis.adoc') to the git repository, so that it is possible to
build the documentation without having a fully installed {pve}
development environment.
Copyright Copyright
--------- ---------