FWGS/waf
2
0
Fork 0
mirror of https://gitlab.com/ita1024/waf.git synced 2024-11-21 17:35:55 +01:00
Code Issues Projects Releases Wiki Activity

Update the documentation

Browse Source
This commit is contained in:
Thomas Nagy 2023-07-15 15:29:53 +02:00
parent 218da8fe28
commit 270a2e09b6
3 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -11,23 +11,17 @@ Waf is a Python-based framework for configuring, compiling and installing applic
* *Documentation*: the application is based on a robust model documented in [The Waf Book](https://waf.io/book/) and in the [API docs](https://waf.io/apidocs/) * *Documentation*: the application is based on a robust model documented in [The Waf Book](https://waf.io/book/) and in the [API docs](https://waf.io/apidocs/)
* *Python compatibility*: cPython 2.5 to 3.x, Jython 2.5, IronPython, and Pypy * *Python compatibility*: cPython 2.5 to 3.x, Jython 2.5, IronPython, and Pypy
Waf is used in particular by innovative companies such as [Avalanche Studios](http://www.avalanchestudios.se) and by open-source projects such as [RTEMS](https://www.rtems.org/). Learn more about Waf by reading [The Waf Book](https://waf.io/book/). Learn more about Waf by reading [The Waf Book](https://waf.io/book/). For researchers and build system writers, Waf also provides a framework and examples for creating [custom build systems](https://gitlab.com/ita1024/waf/tree/master/build_system_kit) and [package distribution systems](https://gitlab.com/ita1024/waf/blob/master/playground/distnet/README.rst).
For researchers and build system writers, Waf also provides a framework for creating [custom build systems](https://gitlab.com/ita1024/waf/tree/master/build_system_kit) and [package distribution systems](https://gitlab.com/ita1024/waf/blob/master/playground/distnet/README.rst). Download the project from our page on [waf.io](https://waf.io/), consult the [manual](https://waf.io/book/), the [API documentation](https://waf.io/apidocs/) and the [showcases](https://gitlab.com/ita1024/waf/tree/master/demos) and [experiments](https://gitlab.com/ita1024/waf/tree/master/playground).
Download the project from our page on [waf.io](https://waf.io/) or from a mirror on [freehackers.org](http://www.freehackers.org/~tnagy/release/), consult the [manual](https://waf.io/book/), the [API documentation](https://waf.io/apidocs/) and the [showcases](https://gitlab.com/ita1024/waf/tree/master/demos) and [experiments](https://gitlab.com/ita1024/waf/tree/master/playground).
## HOW TO CREATE THE WAF SCRIPT ## HOW TO CREATE THE WAF SCRIPT
Python >= 2.6 is required to generate the waf script, and the resulting file can then run on Python 2.5. Python >= 2.7 is required to generate the waf script:
Just run:
```sh ```sh
$ python ./waf-light configure build $ python ./waf-light configure build
``` ```
Or, if several python versions are installed:
```sh
$ python3 ./waf-light configure build
```
## CUSTOMIZATION ## CUSTOMIZATION

BIN
docs/sphinx/_images/waf-64x64.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

6
docs/sphinx/conf.py
View File

@ -357,7 +357,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Waf' project = u'Waf'
copyright = u'2005-2022, Thomas Nagy' copyright = u'2005-2023 waf.io'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -505,7 +505,7 @@ latex_elements = {
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'waf.tex', u'waf Documentation', ('index', 'waf.tex', u'waf Documentation',
u'Thomas Nagy', 'manual'), u'waf.io', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -538,7 +538,7 @@ latex_documents = [
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'waf', u'waf Documentation', ('index', 'waf', u'waf Documentation',
[u'Thomas Nagy'], 1) [u'waf.io'], 1)
] ]
#autodoc_default_flags = ['members', 'no-undoc-members', 'show-inheritance'] #autodoc_default_flags = ['members', 'no-undoc-members', 'show-inheritance']