Skip to content

DOC: add documentation for Meson arguments #291

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

Merged
merged 2 commits into from
Mar 14, 2023

Conversation

peter-urban
Copy link
Contributor

@peter-urban peter-urban commented Feb 2, 2023

This is a draft for the (how-to) meson-args documentation. It includes an example for using meson install_tags using meson-python's install options (PR #288 and issue #68)

I could not yet answer all todos
(Mention the order in which Meson arguments are added, and how it affect Meson)
and
(Explain how you can add extra Meson arguments via the build config settings)

Feel free to comment on what you like/dislike or directly copy/modify it to you liking

@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from 8ea3b4a to fcd1756 Compare February 2, 2023 14:53
@peter-urban peter-urban changed the title Draft for meson-args.rst DOC: draft for meson-args.rst Feb 2, 2023
@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from fcd1756 to dedfc88 Compare February 2, 2023 15:02
@rgommers rgommers added the documentation Improvements or additions to documentation label Feb 2, 2023
@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch 4 times, most recently from d55fb81 to ecc4a45 Compare February 2, 2023 21:57
Copy link
Member

@FFY00 FFY00 left a comment

Choose a reason for hiding this comment

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

I have some comments, these are all kind-of nitpicks. If they are too much for you, I can definitely fix them before merging.

Regarding the pypa/build vs pip commands. We could actually use https://sphinx-design.readthedocs.io/en/latest/tabs.html instead, I think it would look better. They should probably be synchronized tabs too.

@FFY00
Copy link
Member

FFY00 commented Feb 3, 2023

Regardless, this is very much appreciated @peter-urban!

@peter-urban
Copy link
Contributor Author

Hi @FFY00, your comments are appreciated!
I am planning to use sphinx in my own project and I am happy to learn some things about styling.

I'll check through your comments in the coming days and apply them one after the other.
(I don't think there is a rush here right?)

@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch 14 times, most recently from 0df1b77 to 1d9f4ca Compare February 3, 2023 21:14
@peter-urban
Copy link
Contributor Author

peter-urban commented Feb 3, 2023

Ok, I had surprisingly much time tonight :-D
It's ready for another revision round.

@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from 1d9f4ca to 5e7f0f5 Compare February 3, 2023 21:29
@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from 5e7f0f5 to f373fac Compare March 10, 2023 09:24
@peter-urban peter-urban requested a review from FFY00 March 10, 2023 09:26
@peter-urban
Copy link
Contributor Author

@FFY00 ... sorry I didn't want to be pushy with the 're-review' request. I mistook the double arrow symbol next to your name as "update"

@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from f373fac to f99ec0d Compare March 10, 2023 09:40
@peter-urban
Copy link
Contributor Author

I removed the note "admonition:: All four categories must exist" because #293 was resolved in #304

@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from f99ec0d to 0447aff Compare March 10, 2023 10:41
@peter-urban
Copy link
Contributor Author

Regarding the pypa/build vs pip commands. We could actually use https://sphinx-design.readthedocs.io/en/latest/tabs.html instead, I think it would look better. They should probably be synchronized tabs too.

I rewrote the examples using the sphinx-design tabs command

@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch 2 times, most recently from fe44536 to a34aad2 Compare March 10, 2023 10:59
@FFY00
Copy link
Member

FFY00 commented Mar 10, 2023

@FFY00 ... sorry I didn't want to be pushy with the 're-review' request. I mistook the double arrow symbol next to your name as "update"

No worries at all! FYI pinging me often if something is blocked on me is actually helpful, so not bothered at all by pings.

@FFY00 FFY00 mentioned this pull request Mar 10, 2023
Copy link
Member

@FFY00 FFY00 left a comment

Choose a reason for hiding this comment

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

@peter-urban thank you so much! This is great!

I just have some final comments, and then we can go ahead and merge this.

Also, if you could remove the points you tackled in the PR from the todo list at the top of the page, that'd be appreciated.

This is a draft for the (how to) meson-args
documentation
@peter-urban peter-urban force-pushed the add_doc_for_meson_option branch from a34aad2 to 1370fae Compare March 10, 2023 21:20
@peter-urban peter-urban requested a review from FFY00 March 10, 2023 21:23
@peter-urban
Copy link
Contributor Author

I adapted your suggestions. Let me know what you think.

Copy link
Member

@FFY00 FFY00 left a comment

Choose a reason for hiding this comment

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

Thanks @peter-urban, looks great!

There are just some minor fixups, but I'll apply those via Github's UI and mege 😊

@FFY00 FFY00 changed the title DOC: draft for meson-args.rst DOC: add documentation for Meson arguments Mar 14, 2023
@FFY00 FFY00 merged commit 87435a5 into mesonbuild:main Mar 14, 2023
@peter-urban peter-urban deleted the add_doc_for_meson_option branch March 14, 2023 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants