Skip to content

sphinxcontrib-ditaa: init at 1.0.2#309307

Closed
Rconybea wants to merge 3 commits intoNixOS:masterfrom
Rconybea:add-sphinxcontrib-ditaa
Closed

sphinxcontrib-ditaa: init at 1.0.2#309307
Rconybea wants to merge 3 commits intoNixOS:masterfrom
Rconybea:add-sphinxcontrib-ditaa

Conversation

@Rconybea
Copy link
Contributor

@Rconybea Rconybea commented May 5, 2024

Description of changes

Add sphinx plugin to invoke ditaa.

  1. ditaa (nixpkgs.ditaa) renders ascii art block diagrams to image formats like .svg
  2. sphinx (nixpkgs.python3xxPackages.sphinx) generates documentation from .rst text files
  3. sphinxcontrib-ditaa (https://pypi.org/project/sphinxcontrib-ditaa) adds sphinx markup to send a block of text to ditaa for rendering. Analogous to existing packages such as nixpkgs.python3xxPackages.sphinxcontrib-plantuml.

Executable content comprises about 200 lines of python.
nix package adapted from sphinxcontrib-blockdiag

Things done

Using successfully for sphinx-generated documentation in xo-unit (https://github.com/rconybea/xo-unit),
and user environment in xo-nix2 (https://github.com/rconybea/xo-nix2/flake.nix)

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

Rconybea added 2 commits May 5, 2024 11:35
Sphinx plugin that invokes ditaa to nicely render ascii block diagram art
No built-in tests;  tested manually on x86_64.
@github-actions github-actions bot added 6.topic: python Python is a high-level, general-purpose programming language. 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` labels May 5, 2024
@NixOSInfra NixOSInfra added the 12.first-time contribution This PR is the author's first one; please be gentle! label May 5, 2024
@ofborg ofborg bot added 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels May 5, 2024
@FlameFlag
Copy link
Member

FlameFlag commented May 5, 2024

Your commits are breaking Commit Conventions please rebase.

In your case reword 0ad2611 to maintainers: add rconybea and squash 2df67b6 into 18ec38b and reword 18ec38b to sphinxcontrib-ditaa: init at 1.0.2

Please also change your PR title to: sphinxcontrib-ditaa: init at 1.0.2 as well.

@Rconybea Rconybea changed the title Add sphinxcontrib ditaa sphinxcontrib-ditaa: init at 1.0.2 May 6, 2024
@Rconybea Rconybea closed this May 6, 2024
@Rconybea Rconybea deleted the add-sphinxcontrib-ditaa branch May 6, 2024 01:36
@Rconybea
Copy link
Contributor Author

Rconybea commented May 6, 2024

Created new PR reflecting review feedback here: #309426

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: python Python is a high-level, general-purpose programming language. 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 12.first-time contribution This PR is the author's first one; please be gentle!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants