The project yaml configuration file defines how your documentation will look.
For each version, you can select which configuration file to use.
You can either select a configuration file from your repository, or from several alternatives we store in our database:
Default Configuration
sidebar:
Basic Tutorial:
- Getting Started: README.rst
- License: LICENSE
Advanced Tutorial:
- Algorithms: doc/algorithms.rst
- conf.py: doc/conf.py
- Containers: doc/containers.rst
- Design: doc/design.rst
- Guile: doc/guile.rst
- Implementation: doc/implementation.rst
- Index: doc/index.rst
- Introduction: doc/introduction.rst
- Memory: doc/memory.rst
- Python: doc/python.rst
- Requirements: doc/requirements.txt
- Transients: doc/transients.rst
- Utilities: doc/utilities.rst
Example:
- Array:
- array.cpp: example/array/array.cpp
- Box:
- box.cpp: example/box/box.cpp
- Flex Vector:
- flex-vector.cpp: example/flex-vector/flex-vector.cpp
- Map:
- intro.cpp: example/map/intro.cpp
- Set:
- intro.cpp: example/set/intro.cpp
- Vector:
- fizzbuzz.cpp: example/vector/fizzbuzz.cpp
- gc.cpp: example/vector/gc.cpp
- intro.cpp: example/vector/intro.cpp
- iota-move.cpp: example/vector/iota-move.cpp
- iota-slow.cpp: example/vector/iota-slow.cpp
- iota-transient-std.cpp: example/vector/iota-transient-std.cpp
- iota-transient.cpp: example/vector/iota-transient.cpp
- move.cpp: example/vector/move.cpp
- vector.cpp: example/vector/vector.cpp
Important API:
- append: api/immer/flex_vector_transient/append
- box: api/immer/box
- array: api/immer/array
- vector: api/immer/vector
- flex_vector: api/immer/flex_vector
- set: api/immer/set
- map: api/immer/map
- immer: api/immer
- memory_policy: api/immer/memory_policy
- heap_policy: api/immer/heap_policy
autodocSettings:
Public API:
baseUrl: api
language: cpp
INPUT: immer
EXCLUDE: test example
EXCLUDE_PATTERNS: '*/tests/* */test/*'
#1 Alternative Configuration
Yaml configuration file is empty
#2 Alternative Configuration
Yaml configuration file is empty
#3 Alternative Configuration
Yaml configuration file is empty