summaryrefslogtreecommitdiff
path: root/docs/refman
AgeCommit message (Collapse)Author
2025-11-18docs: Generate functions pagesSwagtoy
Currently meson generates a huge page for functions. For now we'll keep compatibility with it, but it's a lot cleaner to have separate pages as well as it makes it easier for search engines to parse as well as sending direct links Signed-off-by: Swagtoy <me@ow.swag.toys>
2025-09-03Use https for mesonbuild.comTobias Stoeckmann
Since http://mesonbuild.com redirects to https://mesonbuild.com anyway, use https directly in documentation.
2025-04-03Docs: Cleaner admonishment stylingFeRD (Frank Dana)
2024-09-11Fix typosspaette
2023-12-13Use SPDX-License-Identifier consistentlyDylan Baker
This replaces all of the Apache blurbs at the start of each file with an `# SPDX-License-Identifier: Apache-2.0` string. It also fixes existing uses to be consistent in capitalization, and to be placed above any copyright notices. This removes nearly 3000 lines of boilerplate from the project (only python files), which no developer cares to look at. SPDX is in common use, particularly in the Linux kernel, and is the recommended format for Meson's own `project(license: )` field
2023-11-26fix broken type annotation imports being ignoredEli Schwartz
If an annotation could not be resolved, it's classified as a "missing import" and our configuration ignored it: ``` Skipping analyzing "mesonbuild.backends": module is installed, but missing library stubs or py.typed marker ``` As far as mypy is concerned, this library may or may not exist, but it doesn't have any typing information at all (may need to be installed first). We ignored this because of our docs/ and tools/ thirdparty dependencies, but we really should not. It is trivial to install them, and then enforce that this "just works". By enforcing it, we also make sure typos get caught.
2023-09-07docs: refman: add vim syntax file generatorLiam Beguin
Signed-off-by: Liam Beguin <liambeguin@gmail.com>
2023-08-18docs: use future annotations for genrefman types in typing_extensionsEli Schwartz
And in fact *use* typing_extensions, which is sometimes the only way to get access to TypedDict. Mostly, reindent almost but not quite an entire file to only define annotation classes under TYPE_CHECKING.
2023-05-31mlog: use a hidden class for stateDylan Baker
This is a pretty common pattern in python (the standard library uses it a ton): A class is created, with a single private instance in the module, and then it's methods are exposed as public API. This removes the need for the global statement, and is generally a little easier to reason about thanks to encapsulation.
2023-05-03doc: Add link to argument detailsXavier Claessens
2023-04-11fix various spelling issuesJosh Soref
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-03-28doc: Use better name for builtin/return object titleXavier Claessens
The title is used only in the sidebar. There is no need to have "extends" information there. For returned objects the actual name is not meaningful so it's better to use the long name. For builtin objects the name is important because that's the global variable name.
2022-11-24Fix various spelling errorsDavid Robillard
Found with codespell.
2022-10-23Fix typos in docsElliott Sales de Andrade
2022-04-07docs: refman: Add `arg_flattening` supportDaniel Mensinger
2022-01-31doc: fix regression that deleted all methods from the reference manualEli Schwartz
Regressed in commit bfb12222c3f64c4dac45fa526a355fffa74dbecd. This needs to iterate over all methods, process them, and add them to a list. Instead, it deleted all methods, processed all remaining methods, and appended them to the in-use iterator. Use a second list, instead. Fixes #9922
2022-01-31print warning when using fastyaml loaderStone Tickle
2022-01-31add --quiet option to genrefmanStone Tickle
2022-01-31add fastyaml loaderStone Tickle
2022-01-06add man page backend to refmanStone Tickle
2022-01-05cleanup _extract_meson_version()Stone Tickle
2021-10-24Merge pull request #9377 from mensinda/jsonDocsJussi Pakkanen
docs: Add a JSON documentation backend
2021-10-21Fix typosHofer-Julian
"seperator" -> "separator"
2021-10-09docs: Update docsDaniel Mensinger
2021-10-09docs: Added JSON generatorDaniel Mensinger
2021-10-07docs: Added pickle RefMan loaderDaniel Mensinger
2021-10-07docs: minor model refectoringDaniel Mensinger
2021-10-04docs: Temporarily disable modules and move RefMan --> Reference-manualDaniel Mensinger
2021-10-04Minor fixupsDaniel Mensinger
2021-10-03docs: Fix mypyDaniel Mensinger
2021-10-03docs: Use a custom hotdoc extension for links to RefManDaniel Mensinger
2021-10-03docs: Added Markdown generatorDaniel Mensinger
2021-10-03docs: Added pickle generatorDaniel Mensinger
2021-10-03docs: Initial reference manual generatorDaniel Mensinger