aboutsummaryrefslogtreecommitdiff
path: root/documentation/tools/books-toc-parts-creator.py
Commit message (Collapse)AuthorAgeFilesLines
* New Documentation PortalSergio Carlavilla Delgado2021-12-111-216/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | I'm very pleased to announce the release of our new Documentation Portal. Key features: * Responsive * Modern design * Theme support: Light, Dark, High contrast * Removed Python dependency Acknowledgment: * Alexander Leidinger <netchild (at) FreeBSD.org> * Baptiste Daroussin <bapt (at) FreeBSD.org> * Benedict Reuschling <bcr (at) freebsd.org> * Daniel Ebdrup Jensen <debdrup (at) FreeBSD.org> * Danilo G. Baio <dbaio (at) FreeBSD.org> * Dave Cottlehuber <dch (at) FreeBSD.org> * Ed Maste <emaste (at) FreeBSD.org> * Fernando ApesteguĂ­a <fernape (at) FreeBSD.org> * Pedro Giffuni <pfg (at) FreeBSD.org> * Joseph Mingrone <jrm (at) ftfl.ca> * Rocky Hotas <rockyhotas (at) firemail.cc> * Pau Amma <pauamma (at) gundo.com> * The FreeBSD Foundation Approved by: core, doceng
* Build offline documentation using Hugo and other improvementsSergio Carlavilla Delgado2021-11-031-6/+13
| | | | | | | | | | | | | | | | | | | | | | * Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
* documentation/tools: warn, but don't fail, on languages without books.Ceri Davies2021-06-161-0/+5
| | | | | | This allows us to pass a full list of languages to the pdf target. The -o option does not warn, continuing merely to print a list of files that it would create.
* tools/books*py: improve argument handling of DOC_LANG, and othersCeri Davies2021-06-131-13/+30
| | | | | | | | | | | | | | | | | | 1) fix shebang lines; 2) add a -o option that makes no changes but prints the files that would be updated/created; 3) allow the -l argument (and therefore DOC_LANG) to be whitespace separated, comma separated, or a mixture of both Item 2 allows us to start tracking dependencies in Makefiles if we wish and therefore reintroduce incremental builds, reducing the amount of .PHONY targets that are not truly phony. Item 3 restores compability with the documented DOC_LANG variable, which was previously whitespace separated. Reviewed by: dbaio, blackend Differential Revision: https://reviews.freebsd.org/D30732
* Modify the script used to generate the ToC partsSergio Carlavilla Delgado2021-03-311-43/+49
| | | | | Modify the script used to generate the different ToC for the partN.adoc files
* Use @generated in generated filesEd Maste2021-02-041-1/+1
| | | | | | | | | | @generated is used by various tools to identify generated files. For example, Phabricator will not display diffs in generated files by default. Reviewed by: gjb Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D28446
* Migrate doc to Hugo/AsciiDoctorSergio Carlavilla Delgado2021-01-251-0/+181
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core