Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: mrdocs.yml file patterns #820

Merged
merged 1 commit into from
Feb 12, 2024
Merged

docs: mrdocs.yml file patterns #820

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions doc/mrdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,30 @@
verbose: true
multipage: true
inaccessible-members: never
inaccessible-bases: never
include:
- ../include
# Input
input:
# Directories that contain documented source files
include:
- ../include
# Patterns to filter out the source-files in the directories
file-patterns:
- '*.hpp'
source-root: ..
base-url: https://www.github.com/boostorg/url/blob/develop/include/ # boost/url/url_view.hpp
generate: adoc

# Filters
filters:
symbols:
exclude:
- 'boost::urls::detail'
- 'boost::urls::*::detail'
- 'boost::empty_'
inaccessible-members: never
inaccessible-bases: never

# Generator
generate: adoc
base-url: https://www.github.com/boostorg/url/blob/develop/include/ # boost/url/url_view.hpp

# Style
verbose: true
multipage: true

# BUILD_TESTING is required for header-only functionality to be extracted
cmake: '-D BUILD_TESTING=ON -D BOOST_URL_BUILD_EXAMPLES=OFF'
cmake: '-D BUILD_TESTING=ON -D BOOST_URL_BUILD_EXAMPLES=OFF'
Loading