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

improve samples management #60

Open
lw64 opened this issue Nov 15, 2024 · 1 comment
Open

improve samples management #60

lw64 opened this issue Nov 15, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers Infrastructure Everything that is not the documentation content itself

Comments

@lw64
Copy link
Contributor

lw64 commented Nov 15, 2024

I just found this sphinx feature:

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude

I think we should use this for vala samples, it makes it much more easy and also has the benefit that you can look at the raw samples without all the text around it. (on gitlab (maybe a link to there would be even useful)
@lw64 lw64 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers Infrastructure Everything that is not the documentation content itself labels Nov 15, 2024
@colinkiama
Copy link
Member

Thanks for sharing this. This makes it much easier to include add code examples to the website

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers Infrastructure Everything that is not the documentation content itself
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@colinkiama @lw64