xo-tokenizer2/xo-tokenizer/docs
2025-07-06 14:13:44 -05:00
..
_static
CMakeLists.txt
conf.py
examples.rst
implementation.rst
index.rst
input-state-class.rst
install.rst xo-reader xo-expression: nested lambdas working properly + docs 2025-07-06 14:13:44 -05:00
README
scan-result-class.rst
schematika-tokens.rst
span-class.rst
token-class.rst
tokenizer-class.rst
tokenizer-error-class.rst
tokentype-enum.rst

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 |    |   +- html/      |
           |     +---------------------------------------+    |   +- xml/       |
           |                                                  +-----------------+
           |                                                     |
           |                                        /------------/
           |                                        |
           |                                        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