From 270a2e09b6ef4a2d436029f36b2a73aee0ab16e3 Mon Sep 17 00:00:00 2001 From: Thomas Nagy Date: Sat, 15 Jul 2023 15:29:53 +0200 Subject: [PATCH] Update the documentation --- README.md | 14 ++++---------- docs/sphinx/_images/waf-64x64.png | Bin 2214 -> 2013 bytes docs/sphinx/conf.py | 6 +++--- 3 files changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f27e73af..1b48604e 100644 --- a/README.md +++ b/README.md @@ -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/) * *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/) 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). +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). ## 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. -Just run: +Python >= 2.7 is required to generate the waf script: + ```sh $ python ./waf-light configure build ``` -Or, if several python versions are installed: -```sh -$ python3 ./waf-light configure build -``` ## CUSTOMIZATION diff --git a/docs/sphinx/_images/waf-64x64.png b/docs/sphinx/_images/waf-64x64.png index cbe55f639e50a897ae4410ad4e4298198d7515b8..2ce7296ffe04b6d0ac33eb4739a378bc08a06425 100644 GIT binary patch delta 10 RcmZ1`c$a^I@y0)^*Z~>h1jPUV delta 211 zcmcc1zf5p~aXkZPfk$L91A}TO2s6%_@u-b~fkCpwHKHUqKdq!Zu_%?Hyu4g5GcUV1 zIk6yBFTW^#_B$IXpdvnyqL9pz9H5HCG=-e}^!({+fz?16A&`t?X-P(Y5kp8uer{s1 zf?r~KWnSyPFrchANY*8_IJqdZz@sEHKaasDGdVS{IMs?vAvswgsZuvDnM)y~q@=(~ tUq87hHL)bKEHyblH#a}87-YSEVp4u-iGB`5Q?WkRj4P8@ZZurO4gmJhNbmpv diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 923ea830..a8019270 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -357,7 +357,7 @@ master_doc = 'index' # General information about the project. 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 # |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]). latex_documents = [ ('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 @@ -538,7 +538,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'waf', u'waf Documentation', - [u'Thomas Nagy'], 1) + [u'waf.io'], 1) ] #autodoc_default_flags = ['members', 'no-undoc-members', 'show-inheritance']