bucket_32/python-gi-docgen

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-gi-docgen
   4 VERSION=                2023.3
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Documentation tool for GObject-based libs (3.11)
   8 SDESC[v12]=             Documentation tool for GObject-based libs (3.12)
   9 HOMEPAGE=               https://gitlab.gnome.org/GNOME/gi-docgen
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/9a/9a/1221564e13c97af17ebf55da41267799b630d0258530152a75feffe99eec
  14 DISTFILE[1]=            gi_docgen-2023.3-py2.py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             complete
  17                         primary
  18                         dev
  19 SPKGS[v12]=             complete
  20                         primary
  21                         dev
  22
  23 OPTIONS_AVAILABLE=      PY311 PY312
  24 OPTIONS_STANDARD=       none
  25 VOPTS[v11]=             PY311=ON PY312=OFF
  26 VOPTS[v12]=             PY311=OFF PY312=ON
  27
  28 DISTNAME=               gi_docgen-2023.3.dist-info
  29
  30 GENERATED=              yes
  31
  32 [PY311].RUN_DEPENDS_ON=                 python-Markdown:single:v11
  33                                         python-MarkupSafe:single:v11
  34                                         python-Pygments:single:v11
  35                                         python-Jinja2:single:v11
  36                                         python-packaging:single:v11
  37                                         python-typogrify:single:v11
  38 [PY311].USES_ON=                        python:v11,wheel
  39
  40 [PY312].RUN_DEPENDS_ON=                 python-Markdown:single:v12
  41                                         python-MarkupSafe:single:v12
  42                                         python-Pygments:single:v12
  43                                         python-Jinja2:single:v12
  44                                         python-packaging:single:v12
  45                                         python-typogrify:single:v12
  46 [PY312].USES_ON=                        python:v12,wheel
  47
  48 post-install:
  49         ${MV} ${STAGEDIR}${PREFIX}/share/pkgconfig/gi-docgen.pc ${STAGEDIR}${PREFIX}/lib/pkgconfig/gi-docgen.pc
  50         ${RMDIR} ${STAGEDIR}${PREFIX}/share/pkgconfig
  51         ${REINPLACE_CMD} 's!/usr/share:!/${PREFIX}/share:/usr/share:!' ${STAGEDIR}${PREFIX}/lib/python${PYTHON_VER}/site-packages/gidocgen/utils.py
  52
  53 [FILE:2334:descriptions/desc.primary]
  54 GI-DocGen: Documentation tool for GObject-based libraries
  55 -------------------------------------------------------------------------------
  56
  57 GI-DocGen is a document generator for GObject-based libraries. GObject is
  58 the base type system of the GNOME project. GI-Docgen reuses the
  59 introspection data generated by GObject-based libraries to generate the API
  60 reference of these libraries, as well as other ancillary documentation.
  61
  62 ## Installation
  63
  64 ### Running GI-DocGen uninstalled
  65
  66 You can run GI-DocGen from its repository, by calling:
  67
  68 ```
  69 ./gi-docgen.py
  70 ```
  71
  72 GI-DocGen will automatically detect this case.
  73
  74 ### Installing GI-DocGen via pip
  75
  76 To install GI-DocGen, you will need to have the following pieces of
  77 software
  78 available on your computer:
  79
  80  - Python 3.6, or later
  81  - pip
  82
  83 Run the following command:
  84
  85 ```
  86 pip3 install --user gi-docgen
  87 ```
  88
  89 After running the command above, make sure to have the `~/.local/bin`
  90 directory listed in your `$PATH` environment variable.
  91
  92 To update GI-DocGen, run the following command:
  93
  94 ```
  95 pip3 install --user --upgrade gi-docgen
  96 ```
  97
  98 ## Usage
  99
 100 First, read [the GI-DocGen tutorial].
 101
 102 The documentation for GI-DocGen is [available online].
 103
 104 The `examples` directory in the repository contains simple project files
 105 for
 106 various GNOME libraries.
 107
 108 ## Disclaimer
 109
 110 GI-DocGen is **not** a general purpose documentation tool for C libraries.
 111
 112 While GI-DocGen can be used to generate API references for most GObject/C
 113 libraries that expose introspection data, its main goal is to generate the
 114 reference for GTK and its immediate dependencies. Any and all attempts at
 115 making this tool more generic, or to cover more use cases, will be weighted
 116 heavily against its primary goal.
 117
 118 GI-DocGen is still in development. The recommended use of GI-DocGen is to
 119 add it as a sub-project to your [Meson build system],
 120 and vendor it when releasing dist archives.
 121
 122 You should **not** depend on a system-wide installation until GI-DocGen is
 123 declared stable.
 124
 125 If you need a general purpose documentation tool, I strongly recommend:
 126
 127  - [HotDoc]
 128  - [Doxygen]
 129  - [GTK-Doc]
 130
 131 ## Copyright and Licensing terms
 132
 133 Copyright 2021  GNOME Foundation
 134
 135 GI-DocGen is released under the terms of the Apache License, version 2.0,
 136 or
 137 under the terms of the GNU General Public License, either version 3.0 or,
 138 at your option, any later version.
 139
 140
 141 [FILE:116:distinfo]
 142 4375f2e35fdb6fef6dfe7026ede1077fd515a9ca72adc5555db291428a101310      1260856 gi_docgen-2023.3-py2.py3-none-any.whl
 143