Point to source for command reference docs #134
Conversation
|
Since this page is generated, I don't think we can manually add text. Maybe @mwleeds can advise... |
|
It looks like the HTML file is generated - the rst files I modified are just stubs that point to the HTML. |
When you're looking at the Flatpak Command Reference on docs.flatpak.org, it's not clear that it was generated from the flatpak repo. So add a notice to the docbook that's used to generate the HTML. This was pointed out by flatpak/flatpak-docs#134
When you're looking at the Flatpak Builder Command Reference on docs.flatpak.org, it's not clear that it was generated from the flatpak-builder repo. So add a notice to the docbook that's used to generate the HTML. This was pointed out by flatpak/flatpak-docs#134
|
(Sorry I didn't see the notification from this.) While the rst files are not generated, it also doesn't seem to work to add text like this, based on checking the output after running |
|
It wasn't mean to add text in the output - it was a comment in the source code. It's entirely possible to add text in the rst as well - just write normal text without the |
|
Oh! Well we could do both then |
|
My process was that I clicked the "Edit on Github" link and got to this page. But I'd probably have seen the generated notice you've now got on the webpage, so I think that's a satisfactory solution too. |
I wanted to contribute to the reference docs, and was temporarily confused about where they come from. So once I worked it out, I thought I'd clarify it for anyone else who reaches the same place.
The
..syntax is a rst comment, so these messages are only visible to people looking at the docs source.