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

switch to nixos-render-docs #34

Merged
merged 7 commits into from
Dec 4, 2023
Merged

switch to nixos-render-docs #34

merged 7 commits into from
Dec 4, 2023

Conversation

ibizaman
Copy link
Owner

@ibizaman ibizaman commented Dec 4, 2023 •
edited
Loading

fixes #33

Phew, that was something.

The patch was needed otherwise I would get this error:

self-host-blocks-manual> Traceback (most recent call last):
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 510, in _included_thing
self-host-blocks-manual>     inner.append(self.render(included))
self-host-blocks-manual>                  ^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 152, in render
self-host-blocks-manual>     return super().render(tokens)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/html.py", line 43, in render
self-host-blocks-manual>     result = super().render(tokens)
self-host-blocks-manual>              ^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 149, in render
self-host-blocks-manual>     return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 129, in _join_block
self-host-blocks-manual>     return "".join(ls)
self-host-blocks-manual>            ^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 149, in <lambda>
self-host-blocks-manual>     return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>                                             ^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 144, in do_one
self-host-blocks-manual>     return self.renderInline(token.children)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 156, in renderInline
self-host-blocks-manual>     return self._join_inline(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 131, in _join_inline
self-host-blocks-manual>     return "".join(ls)
self-host-blocks-manual>            ^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 156, in <lambda>
self-host-blocks-manual>     return self._join_inline(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>                                              ^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 153, in do_one
self-host-blocks-manual>     return self.rules[token.type](tokens[i], tokens, i)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/html.py", line 231, in image
self-host-blocks-manual>     src = self._pull_image(cast(str, token.attrs['src']))
self-host-blocks-manual>           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 262, in _pull_image
self-host-blocks-manual>     content = (self._in_dir / src_path).read_bytes()
self-host-blocks-manual>               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/cb4f14pp0ikyndpafc302gj0b2faqh6a-python3-minimal-3.11.6/lib/python3.11/pathlib.py", line 1050, in read_bytes
self-host-blocks-manual>     with self.open(mode='rb') as f:
self-host-blocks-manual>          ^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/cb4f14pp0ikyndpafc302gj0b2faqh6a-python3-minimal-3.11.6/lib/python3.11/pathlib.py", line 1044, in open
self-host-blocks-manual>     return io.open(self, mode, buffering, encoding, errors, newline)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual> FileNotFoundError: [Errno 2] No such file or directory: 'blocks/monitoring/blocks/monitoring/assets/dashboards_Errors_1.png'
self-host-blocks-manual> The above exception was the direct cause of the following exception:
self-host-blocks-manual> Traceback (most recent call last):
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 510, in _included_thing
self-host-blocks-manual>     inner.append(self.render(included))
self-host-blocks-manual>                  ^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 152, in render
self-host-blocks-manual>     return super().render(tokens)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/html.py", line 43, in render
self-host-blocks-manual>     result = super().render(tokens)
self-host-blocks-manual>              ^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 149, in render
self-host-blocks-manual>     return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 129, in _join_block
self-host-blocks-manual>     return "".join(ls)
self-host-blocks-manual>            ^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 149, in <lambda>
self-host-blocks-manual>     return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>                                             ^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 146, in do_one
self-host-blocks-manual>     return self.rules[token.type](tokens[i], tokens, i)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 140, in <lambda>
self-host-blocks-manual>     'included_parts': lambda *args: self._included_thing("part", *args),
self-host-blocks-manual>                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 512, in _included_thing
self-host-blocks-manual>     raise RuntimeError(f"rendering {path}") from e
self-host-blocks-manual> RuntimeError: rendering blocks/monitoring/dashboard-errors.md
self-host-blocks-manual> The above exception was the direct cause of the following exception:
self-host-blocks-manual> Traceback (most recent call last):
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 39, in convert
self-host-blocks-manual>     converted = self._renderer.render(tokens)
self-host-blocks-manual>                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 150, in render
self-host-blocks-manual>     return self._render_book(tokens)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 301, in _render_book
self-host-blocks-manual>     super(HTMLRenderer, self).render(tokens[6:]),
self-host-blocks-manual>     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 149, in render
self-host-blocks-manual>     return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 129, in _join_block
self-host-blocks-manual>     return "".join(ls)
self-host-blocks-manual>            ^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 149, in <lambda>
self-host-blocks-manual>     return self._join_block(map(lambda arg: do_one(*arg), enumerate(tokens)))
self-host-blocks-manual>                                             ^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/md.py", line 146, in do_one
self-host-blocks-manual>     return self.rules[token.type](tokens[i], tokens, i)
self-host-blocks-manual>            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 140, in <lambda>
self-host-blocks-manual>     'included_parts': lambda *args: self._included_thing("part", *args),
self-host-blocks-manual>                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 512, in _included_thing
self-host-blocks-manual>     raise RuntimeError(f"rendering {path}") from e
self-host-blocks-manual> RuntimeError: rendering blocks/monitoring/default.md
self-host-blocks-manual> The above exception was the direct cause of the following exception:
self-host-blocks-manual> Traceback (most recent call last):
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/__init__.py", line 49, in main
self-host-blocks-manual>     manual.run_cli(args)
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 750, in run_cli
self-host-blocks-manual>     _run_cli_html(args)
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 739, in _run_cli_html
self-host-blocks-manual>     md.convert(args.infile, args.outfile)
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 555, in convert
self-host-blocks-manual>     super().convert(infile, outfile)
self-host-blocks-manual>   File "/nix/store/v5pj0lddfzw0hdaxj6lkyznjgfh1pri5-nixos-render-docs-0.0/lib/python3.11/site-packages/nixos_render_docs/manual.py", line 42, in convert
self-host-blocks-manual>     raise RuntimeError(f"failed to render manual {infile}") from e
self-host-blocks-manual> RuntimeError: failed to render manual manual.md
self-host-blocks-manual> error:
self-host-blocks-manual>        failed to render manual manual.md
self-host-blocks-manual> caused by:
self-host-blocks-manual>        rendering blocks/monitoring/default.md
self-host-blocks-manual> caused by:
self-host-blocks-manual>        rendering blocks/monitoring/dashboard-errors.md
self-host-blocks-manual> caused by:
self-host-blocks-manual> [Errno 2] No such file or directory: 'blocks/monitoring/blocks/monitoring/assets/dashboards_Errors_1.png'

(And same for other pngs included)

@ibizaman
Copy link
Owner Author

ibizaman commented Dec 4, 2023

This PR is getting too big. I'll split it out.

@ibizaman ibizaman merged commit a63b0a6 into main Dec 4, 2023
1 check passed
@ibizaman ibizaman deleted the dev branch December 4, 2023 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use nixos-render-docs to generate documentation
1 participant
@ibizaman