pydocmaker
  • Installation
  • Install Optional Requirements
    • Optional Requirement pandoc
    • Optional Requirement Latex
    • Optional Requirement for DOCX either libreoffice or win32com
      • Installing pywin32 (Windows only)
      • Installing libreoffice
  • TL;DR; Example
  • Configuring Options:
  • Examples
    • Getting Started Examples
      • Most minimal example
      • Writing a small pydoc
      • “Showing” Documents in iPython/Terminal
      • Exporting pydocs to common formats
        • Exporting to PDFs (via typst, pandoc, LaTeX, Word, or Libreoffice)
      • Add pyplot Figures to your pydoc
      • Add an image from a numpy array
      • pydoc to python list
      • Storing metadata
      • Adding a table
      • Configuring/testing PDF engines
    • Writing docx Documents
      • To docx (no template, no dependencies)
      • Prepare a template and fields (optional)
      • To docx (no additional dependencies)
      • To docx via Word (with additional dependencies)
      • To PDF via docx with Word (with additional dependencies)
      • To PDF via docx with Libreoffice (with additional dependencies)
      • The hard way: using the low level classes and functions
    • Using templates (HTML and LaTeX)
      • The pydocmaker inbuild templates
      • Definition of templates
      • Adding / defining you own template
      • Using your template
      • Jinja2 templates from strings
    • Export reports to Redmine wiki
      • Build example document to upload
      • Define the connection to our Redmine server
      • The easy way: upload via .upload_report_to_redmine(...)
      • The harder way: export and manual upload
    • Detailed Usage Instructions
      • Doc the Document builder
      • Document part schemas
      • Adding document parts to a doc
      • Working with images
      • Adding parts to specific chapters
      • Using the low level constr constructor factory
  • Data Model
    • Element Properties
    • Supported Types
    • JSON Definition
pydocmaker
  • Search

© Copyright 2025, Tobias Glaubach.

Built with Sphinx using a theme provided by Read the Docs.