Diplodocus
Diplodocus builds a shared documentation site for Python, R, Julia, Rust, and C++ packages. It brings package API references and Markdown and Quarto guides together with shared navigation, cross-references, and search.
Installation
On Linux or macOS, install the latest release with:
|
On Windows, run this in PowerShell:
irm https://diplodocus.cc/install.ps1 | iex
Prebuilt binaries are available from GitHub releases. See the installation guide for requirements and other installation options.
Getting started
Create a diplodocus.yaml file to declare your packages and documentation
pages. Use the configuration guide to set up your
project, or adapt the Python, R, Julia, and Rust
example.
From the directory containing your configuration, validate your sources and preview the site:
Open the local URL printed in the terminal. Diplodocus watches your sources and rebuilds the site when they change. To build a site for publishing, run:
Install the language runtimes and package dependencies your documentation needs before building. C++ API extraction uses Doxygen and an explicit Doxyfile. See the quick start for a complete example.
Documentation
License
Diplodocus is licensed under either the Apache License, Version 2.0, or the MIT license, at your option.