https://github.com/nxtlo/syn
Collection of themes for pdoc 🐍
https://github.com/nxtlo/syn
css docs documentation pdoc python templates themes
Last synced: 2 months ago
JSON representation
Collection of themes for pdoc 🐍
- Host: GitHub
- URL: https://github.com/nxtlo/syn
- Owner: nxtlo
- License: unlicense
- Created: 2024-02-20T08:19:25.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T13:00:31.000Z (over 2 years ago)
- Last Synced: 2025-07-13T01:38:19.698Z (12 months ago)
- Topics: css, docs, documentation, pdoc, python, templates, themes
- Language: CSS
- Homepage:
- Size: 743 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# syn
A collection of pdoc themes ready for use.
## Installation
TODO
## Usage
To output the documentation use:
```sh
pdoc -t -d numpy -o
```
To run a local server with one of the themes use the same command without the `-o` option.
A full usage example
```sh
pdoc asyncio -t onedark -o docs
```
## Available styles
Current available styles are the ones not marked with (WIP).
* [Rust](https://doc.rust-lang.org/std/index.html): a theme that's generated by `cargo doc`
* [Dracula](https://github.com/dracula/dracula-theme): classic dracula's color scheme
* [Github](https://github.com/one-dark): github's one dark color scheme
* [Svelte](https://svelte.dev/docs/svelte-components): a theme that's used in svelte's docs (WIP)
### Overview
Svelte WIP>
If you'd like to see one of those themes in action, go to their directory.
## Development
Currently the code isn't organized correctly, but i have a plan to make it simpler
to develop new themes using just `var(--color)`.
### Testing
to test a theme, there's already a module with testing cases pre-defined in it. just use `pdoc _project/core/ -t `