Commit Graph

32 Commits

Author SHA1 Message Date
FeRD (Frank Dana) 95d7fac30a Docs: Cleaner admonishment styling 2025-04-03 00:19:37 +03:00
spaette 4179996fef Fix typos 2024-09-11 15:51:04 -07:00
Dylan Baker e991c4d454 Use SPDX-License-Identifier consistently
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-12-13 15:19:21 -05:00
Eli Schwartz caa38dad45 fix broken type annotation imports being ignored
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-11-26 17:12:52 -05:00
Liam Beguin ba1ba1f5b0
docs: refman: add vim syntax file generator
Signed-off-by: Liam Beguin <liambeguin@gmail.com>
2023-09-07 19:14:03 -04:00
Eli Schwartz 184277bb4a
docs: use future annotations for genrefman types in typing_extensions
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-08-18 11:16:15 -04:00
Dylan Baker ada2a976f0
mlog: use a hidden class for state
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-31 17:20:44 -04:00
Xavier Claessens 4ed5c0eefa doc: Add link to argument details 2023-05-03 15:06:35 -04:00
Josh Soref cf9fd56bc9 fix various spelling issues
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2023-04-11 19:21:05 -04:00
Xavier Claessens 728c8dce24 doc: Use better name for builtin/return object title
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.
2023-03-28 14:56:47 -04:00
David Robillard e85138fcc8 Fix various spelling errors
Found with codespell.
2022-11-24 15:17:23 -05:00
Elliott Sales de Andrade fa2585d0b3 Fix typos in docs 2022-10-23 03:06:39 +03:00
Daniel Mensinger f192ecd1ef docs: refman: Add `arg_flattening` support 2022-04-07 17:16:26 -04:00
Eli Schwartz 8d64853229
doc: fix regression that deleted all methods from the reference manual
Regressed in commit bfb12222c3.

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-31 18:21:31 -05:00
Stone Tickle bd1c464f59 print warning when using fastyaml loader 2022-01-31 18:40:40 +01:00
Stone Tickle f5ffb0a1e9 add --quiet option to genrefman 2022-01-31 18:40:40 +01:00
Stone Tickle bfb12222c3 add fastyaml loader 2022-01-31 18:40:40 +01:00
Stone Tickle ac468a1394
add man page backend to refman 2022-01-06 20:14:29 -06:00
Stone Tickle 95057340b3
cleanup _extract_meson_version() 2022-01-05 11:32:03 -06:00
Jussi Pakkanen 475b8b1ad8
Merge pull request #9377 from mensinda/jsonDocs
docs: Add a JSON documentation backend
2021-10-24 17:46:05 +03:00
Hofer-Julian 939394ed31 Fix typos
"seperator" -> "separator"
2021-10-21 06:57:57 -04:00
Daniel Mensinger 88db532bf9
docs: Update docs 2021-10-09 23:07:24 +02:00
Daniel Mensinger d427c8fdb6
docs: Added JSON generator 2021-10-09 22:41:18 +02:00
Daniel Mensinger ba93dd20ca
docs: Added pickle RefMan loader 2021-10-07 19:46:06 +02:00
Daniel Mensinger f06cdf0606
docs: minor model refectoring 2021-10-07 19:20:58 +02:00
Daniel Mensinger a8189d0c70 docs: Temporarily disable modules and move RefMan --> Reference-manual 2021-10-04 23:11:48 +02:00
Daniel Mensinger b672ebca88
Minor fixups 2021-10-04 19:39:36 +02:00
Daniel Mensinger 239219220e
docs: Fix mypy 2021-10-03 12:19:45 +02:00
Daniel Mensinger 5dd8171fb3
docs: Use a custom hotdoc extension for links to RefMan 2021-10-03 12:19:45 +02:00
Daniel Mensinger 476b93fd74
docs: Added Markdown generator 2021-10-03 11:46:34 +02:00
Daniel Mensinger 955a29a92d
docs: Added pickle generator 2021-10-03 11:46:34 +02:00
Daniel Mensinger ad65a699f9
docs: Initial reference manual generator 2021-10-03 11:46:34 +02:00