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.md
- Quickstart: docs/quickstart.html
Advanced Tutorial:
- Manual: docs/manual.html
- Samples:
- custom_memory_management: docs/samples/custom_memory_management.cpp
- include: docs/samples/include.cpp
- load_error_handling: docs/samples/load_error_handling.cpp
- load_file: docs/samples/load_file.cpp
- load_memory: docs/samples/load_memory.cpp
- load_options: docs/samples/load_options.cpp
- load_stream: docs/samples/load_stream.cpp
- modify_add: docs/samples/modify_add.cpp
- modify_base: docs/samples/modify_base.cpp
- modify_remove: docs/samples/modify_remove.cpp
- save_custom_writer: docs/samples/save_custom_writer.cpp
- save_declaration: docs/samples/save_declaration.cpp
- save_file: docs/samples/save_file.cpp
- save_options: docs/samples/save_options.cpp
- save_stream: docs/samples/save_stream.cpp
- save_subtree: docs/samples/save_subtree.cpp
- text: docs/samples/text.cpp
- traverse_base: docs/samples/traverse_base.cpp
- traverse_iter: docs/samples/traverse_iter.cpp
- traverse_predicate: docs/samples/traverse_predicate.cpp
- traverse_rangefor: docs/samples/traverse_rangefor.cpp
- traverse_walker: docs/samples/traverse_walker.cpp
- xpath_error: docs/samples/xpath_error.cpp
- xpath_query: docs/samples/xpath_query.cpp
- xpath_select: docs/samples/xpath_select.cpp
- xpath_variables: docs/samples/xpath_variables.cpp
Important API:
- xml_document: api/pugi/xml_document
- load_file: api/pugi/xml_document/load_file
- load: api/pugi/xml_document/load
- load_string: api/pugi/xml_document/load_string
- xml_node: api/pugi/xml_node
- xml_attribute: api/pugi/xml_attribute
- xml_parse_result: api/pugi/xml_parse_result
autodocSettings:
Public API:
baseUrl: api
language: cpp
INPUT: src
EXCLUDE: test tests examples
EXCLUDE_PATTERNS: '*/tests/* */test/*'
EXAMPLE_PATH: examples
includeApi: []
excludeApi: []
documentSingleUnderscore: true
documentStatic: true
documentProtected: true
extractNonDocComments: true
ENABLE_PREPROCESSING: 'NO'
MACRO_EXPANSION: 'NO'
EXPAND_ONLY_PREDEF: 'NO'
PREDEFINED: ''
SEARCH_INCLUDES: 'YES'
INCLUDE_PATH: ''
INCLUDE_FILE_PATTERNS: ''
#1 Alternative Configuration
Yaml configuration file is empty
#2 Alternative Configuration
Yaml configuration file is empty
#3 Alternative Configuration
Yaml configuration file is empty