documentation fixes, redux

This commit is contained in:
Mark Gillard 2021-05-09 19:27:08 +03:00
parent 479a550ba7
commit 369b36d288
5 changed files with 51 additions and 26 deletions

View File

@ -9,6 +9,9 @@ end_of_line = lf
trim_trailing_whitespace = true
charset = utf-8
[*.{md,markdown}]
trim_trailing_whitespace = false
[*.{gitattributes,yaml,yml,vcxproj,vcxproj.filters,sln,rc,clang-format,toml}]
indent_style = space

View File

@ -1 +0,0 @@
IMAGE_PATH = images/

View File

@ -1,3 +1,6 @@
# this is a config file for Poxy - a Doxygen + m.css front-end written in Python.
# https://github.com/marzer/poxy
name = 'toml++'
description = 'TOML for modern C++'
cpp = 17
@ -7,10 +10,6 @@ show_includes = false
logo = 'images/logo.png'
favicon = 'images/favicon.ico'
navbar = [ 'namespaces', 'annotated' ]
sources = [ 'pages' ]
recursive_sources = [ '../include' ]
source_patterns = [ '*.h', '*.dox' ]
strip_paths = [ '../include' ]
extra_files = [
'images/banner_small.png',
'images/badge-awesome.svg',
@ -18,10 +17,25 @@ extra_files = [
'images/badge-C++20.svg'
]
[warnings]
enabled = true
treat_as_errors = false
undocumented = true
enabled = true
treat_as_errors = false
undocumented = true
[sources]
paths = [ 'pages' ]
recursive_paths = [ '../include' ]
patterns = [ '*.h', '*.dox' ]
strip_paths = [ '../include' ]
[images]
paths = [ 'images' ]
@ -37,29 +51,37 @@ undocumented = true
[highlighting]
types = []
macros = [
'TOML_[A-Z0-9_]+?',
'print_value'
]
string_literals = [ '_toml' ]
[code_blocks]
macros = [ 'TOML_[A-Z0-9_]+?', 'print_value' ]
string_literals = [ '_toml' ]
[badges]
'1. C++20' = [ 'badge-C++20.svg', 'https://en.cppreference.com/w/cpp/compiler_support' ]
'2. TOML v1.0.0' = [ 'badge-TOML.svg', 'https://toml.io/en/v1.0.0' ]
'3. CircleCI' = [ 'https://img.shields.io/circleci/build/github/marzer/tomlplusplus?label=circle%20ci&logo=circleci&logoColor=white&style=flat-square', 'https://circleci.com/gh/marzer/tomlplusplus' ]
'4. Mentioned in Awesome C++' = [ 'badge-awesome.svg', 'https://github.com/fffaraz/awesome-cpp' ]
'1. C++20' = [
'badge-C++20.svg',
'https://en.cppreference.com/w/cpp/compiler_support'
]
'2. TOML v1.0.0' = [
'badge-TOML.svg',
'https://toml.io/en/v1.0.0'
]
'3. CircleCI' = [
'https://img.shields.io/circleci/build/github/marzer/tomlplusplus?label=circle%20ci&logo=circleci&logoColor=white&style=flat-square',
'https://circleci.com/gh/marzer/tomlplusplus'
]
'4. Mentioned in Awesome C++' = [
'badge-awesome.svg',
'https://github.com/fffaraz/awesome-cpp'
]
[autolinks]
'(?:toml::)?parse[_ ]results?' = 'classtoml_1_1parse__result.html'
'(?:toml::)?parse[_ ]errors?' = 'classtoml_1_1parse__error.html'
'(?:toml::)?node[_ ]views?' = 'classtoml_1_1node__view.html'
'(?:toml::)?json[_ ]formatters?' = 'classtoml_1_1json__formatter.html'
'(?:toml::)?parse[_ ]results?' = 'classtoml_1_1parse__result.html'
'(?:toml::)?parse[_ ]errors?' = 'classtoml_1_1parse__error.html'
'(?:toml::)?node[_ ]views?' = 'classtoml_1_1node__view.html'
'(?:toml::)?json[_ ]formatters?' = 'classtoml_1_1json__formatter.html'
'(?:toml::)?default[_ ]formatters?' = 'classtoml_1_1default__formatter.html'
'(?:toml::)?source[_ ]positions?' = 'structtoml_1_1source__position.html'
'(?:toml::)?source[_ ]regions?' = 'structtoml_1_1source__region.html'
'(?:toml::)?source[_ ]positions?' = 'structtoml_1_1source__position.html'
'(?:toml::)?source[_ ]regions?' = 'structtoml_1_1source__region.html'

View File

@ -730,6 +730,7 @@ TOML_ENABLE_WARNINGS;
/// \detail Defaults to the standard C `assert()`.
#define TOML_CONFIG_HEADER
/// \def TOML_CONFIG_HEADER
/// \brief An additional header to include before any other toml++ header files.
/// \detail Not defined by default.

View File

@ -1,4 +1,4 @@
misk>=0.4.0
poxy>=0.2.0
poxy>=0.3.0
pyyaml
python-dateutil