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.
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
doc: Add PHP section to index #86401
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The approach is right since the .md
-files are converted to docbook using pandoc
first.
However, nix-build doc/
is breaking with this change due to a XML-id collision: python.section.md
and php.section.md
have a User guide
-headline which is transformed into an xml:id
named user-guide
(twice).
It may be possible to work around this in pandoc
(in doc/Makefile
) using --id-prefix
, the easier fix would be however to replace the User guide
-headline in php.section.md
by something else I guess.
TIL how to build the documentation locally! I have made some changes to our headlines and tested it locally :-) |
I tried updating I'll ask upstream pandoc if there's a way around this, but I assume for now we can't namespace |
That means that we shouldn't make headings like |
After looking at the rendered documentation a bit closer, I think it would be good to just get rid of the |
My thought is that it can be good to keep, the reasoning behind that is that I in the future would like to see that we manage to get something in to build things with composer. And that would be it's own headline among the lines But I already dropped one level in this PR 😄 |
Okay, yeah, that makes sense. I guess we could also document |
Motivation for this change
I guess this should work? We have the markdown file from before and I guess that is converted to xml somehow?
Things done
sandbox
innix.conf
on non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
./result/bin/
)nix path-info -S
before and after)