Commit Graph

12 Commits

Author SHA1 Message Date
Tim Hoffmann
b6269d3790
Improve documentation for the Builder API (#13008)
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-12 00:21:34 +01:00
Chris Sewell
c23697aaa7
Use method colour key in the Builder API graph (#12998) 2024-10-11 22:51:32 +01:00
Adam Turner
d135d2eba3
Mark `Builder.write()` as final (#12767) 2024-10-10 15:59:12 +01:00
James Knight
d1c4480f2a
Allow builders to override support for linkcode references (#12852)
Signed-off-by: James Knight <james.d.knight@live.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-06 22:54:02 +01:00
Chris Sewell
0e3f5b4ab2
[DOCS] Improve events (#12446)
Split the events callback API into a separate document, add a flow graph of the events within the build process, add parameters to the events,
and link the `EnvironmentCollector` docs to the relevant events.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-06-20 10:40:22 +02:00
Chris Sewell
37ff33dff7
[builder] type Builder core methods with @final and improve docs (#12436)
This commit:

- annotates the `Builder`'s "core" methods, with [`final`](https://docs.python.org/3/library/typing.html#typing.final)
- adds a UML graph to the Builder API docs
- Adds more methods to the Builder API docs

to make it clearer for extension developers, what is expected from a new builder subclass.
2024-06-19 14:51:20 +02:00
Takeshi KOMIYA
29ac4c1982 Fix #9637: Add Builder.allow_parallel to the list of builder APIs 2021-09-18 01:26:12 +09:00
Takeshi KOMIYA
9e2aba54d3 Make EventManager portable
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
2019-04-06 15:36:50 +09:00
Takeshi KOMIYA
0010179d45 docs: Add description for attributes of Builder (refs: #4402) 2018-01-29 22:41:06 +09:00
Stephen Finucane
a83e8bab7d builders: Add 'Builder.epilog' option
This allows builders to emit a final epilog message containing
information such as where resulting files can be found. This is only
emitted if the build was successful.

This allows us to remove this content from the 'make_mode' tool and
the legacy 'Makefile' and 'make.bat' templates. There's room for more
dramatic simplification of the former, but this will come later.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-11 20:57:03 +00:00
Brecht Machiels
3dd256fe7d Do not include the builder class in the entry point
- use the entry point to load the extension module in the usual way
- update the documentation to reflect this change
2017-04-14 11:01:09 +02:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00