Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

python311Packages.sphinxcontrib-ditaa: init at 1.0.2 #309426

Merged
merged 2 commits into from
May 23, 2024
Merged

python311Packages.sphinxcontrib-ditaa: init at 1.0.2 #309426

merged 2 commits into from
May 23, 2024

Conversation

Rconybea
Copy link
Contributor

@Rconybea Rconybea commented May 6, 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.

@github-actions github-actions bot added 6.topic: python 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` labels May 6, 2024
@Rconybea Rconybea mentioned this pull request May 6, 2024
Closed
13 tasks
@ofborg ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels May 6, 2024
@natsukium
Copy link
Member

Could you please rewrite your commit message and PR title as python311Packages.sphinxcontrib-ditaa: init at 1.0.2?
https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/python.section.md#contributing-guidelines-contributing-guidelines

@Rconybea Rconybea changed the title sphinxcontrib-ditaa: init at 1.0.2 python311Packages.sphinxcontrib-ditaa: init at 1.0.2 May 6, 2024
@Rconybea Rconybea force-pushed the add-sphinxcontrib-ditaa branch 2 times, most recently from 173571c to ba59da8 Compare May 7, 2024 04:32
@Rconybea Rconybea requested a review from natsukium May 7, 2024 14:10
@Rconybea Rconybea force-pushed the add-sphinxcontrib-ditaa branch from 9ee1c85 to 60a37e3 Compare May 19, 2024 21:21
@Rconybea Rconybea requested a review from natsukium May 22, 2024 15:58
@Rconybea Rconybea force-pushed the add-sphinxcontrib-ditaa branch 2 times, most recently from 60a37e3 to 7be01b1 Compare May 22, 2024 23:56
@Rconybea Rconybea force-pushed the add-sphinxcontrib-ditaa branch from 7be01b1 to d473308 Compare May 23, 2024 00:05
natsukium
natsukium approved these changes May 23, 2024
View reviewed changes
Copy link
Member

@natsukium natsukium left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
Could you reformat with nixfmt-rfc-style? ref. #313628

@Rconybea @natsukium
python311Packages.sphinxcontrib-ditaa: init at 1.0.2
197d626 
Co-authored-by: OTABI Tomoya <tomoya.otabi@gmail.com>
@Rconybea Rconybea force-pushed the add-sphinxcontrib-ditaa branch from d473308 to 197d626 Compare May 23, 2024 16:43
@Rconybea
Copy link
Contributor Author

format regularized with nixfmt from pkgs.nixfmt-rfc-style

@Rconybea
Copy link
Contributor Author

@NixOS/nixpkgs-merge-bot merge

@nixpkgs-merge-bot
Copy link
Contributor

@Rconybea merge not permitted (#305350):
maintainers/maintainer-list.nix is not in pkgs/by-name/
pkgs/development/python-modules/sphinxcontrib-ditaa/default.nix is not in pkgs/by-name/
pkgs/top-level/python-packages.nix is not in pkgs/by-name/

@Rconybea
Copy link
Contributor Author

looks like need help to trigger the merge here.

@natsukium natsukium merged commit a36fa54 into NixOS:master May 23, 2024
24 of 25 checks passed
@natsukium
Copy link
Member

Thank you!

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

@natsukium natsukium natsukium approved these changes

Assignees
No one assigned
Labels
6.topic: python 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 10.rebuild-linux: 1-10 11.by: package-maintainer This PR was created by the maintainer of the package it changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Rconybea @natsukium