Publish documentation

CLI Beta

For teams who want an HTML site and a PDF from reStructuredText or MyST sources, built by the ubc CLI.

1. What is ubCode? explains how ubCode works with Sphinx, or instead of it.

2. ubc CLI gets you ubc, a single binary.

3. Quickstart scaffolds a project to build, with a markdown flavor for MyST authors.

4. Building a static HTML site builds and ships a static site, with a builder that is Beta.

5. Building a PDF builds one PDF from the same sources, and Page classes at work shows its page classes at work; Which diagrams draw on a default install says which diagrams it draws with what installed.

6. HTML site and PDF document set the theme, the branding and the page layout.

7. Writing reports and Card designs with [needs.card_layouts] add generated reports and need cards.

8. Writing content and Differences from a Sphinx build say what renders, and where ubc differs from Sphinx; the essentials tour shows the constructs most pages need.

Neither builder renders autodoc (ubCode does not run your code) or Graphviz, and neither numbers sections, figures, tables or equations yet, nor resolves numref; Unsupported syntax lists each with what to write instead.

Next steps

• Upgrade path: add requirements and traceability to the same project with Manage requirements and traceability.

• For your team: ubCode for teams covers licensing, offline use and support.

Use it at work. ubCode is free for open-source projects, and a private project needs a commercial license. Request a free enterprise trial to evaluate it on your own private project.