roland/xo-alloc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
xo-alloc/docs
History
Roland Conybeare 19520f017b xo-object: GC unit test
2025-08-05 11:09:26 -05:00
..
_static + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00
CMakeLists.txt + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00
conf.py + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00
glossary.rst xo-object: GC unit test 2025-08-05 11:09:26 -05:00
implementation.rst + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00
index.rst xo-alloc: mutation log tracking in working state + unit test 2025-08-05 11:08:36 -05:00
install.rst + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00
introduction.rst + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00
README + xo-alloc + xo-object + xo-alloc docs + GC utests 2025-08-03 15:59:38 -05:00

README 

standalone build

        +-----------------------------------------------+
        | cmake                                         |
        |   CMakeLists.txt                              |
        |   $PREFIX/share/cmake/xo_macros/xo_cxx.cmake  |
        +-----------------------------------------------+
           |
           |                                                  +----------------------+
           +------------------------------------------------->| .build/docs/Doxyfile |
           |                                                  +----------------------+
           |                                                     ^
           |                                 (cmake)             |
           |                                        /------------/
           |                                        |
           |     +---------------------------------------+          +-----------------+
           +---->| doxygen                               |--------->| .build/docs/dox |
           |     |   $PREFIX/share/xo-macros/Doxyfile.in | (doxygen)|   +- html/      |
           |     +---------------------------------------+          |   +- xml/       |
           |                                                        +-----------------+
           |                                                             |
           |                                                             |(sphinx)
           |                                                             |
           |                                                             v
           |     +---------------------------------------+        +--------------------+
           \---->| sphinx                                |------->| .build/docs/sphinx |
                 |   +- conf.py                          |        |   +- html/         |
                 |   +- _static/                         |        +--------------------+
                 |   +- *.rst                            |
                 +---------------------------------------+

umbrella build relies on top-level cmake macros

files

   README            this file
   CMakeLists.txt    build entry point
   conf.py           sphinx config
   _static           static files for sphinx

   index.rst         toplevel sphinx document; entry point