Skip to content

Mrdocs #145

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

Merged
steve-downey merged 6 commits into from
Nov 3, 2025
Merged

Mrdocs #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
53a5bba
Add mrdocs configuration
steve-downey Sep 28, 2025
d5ad78e
Support for using mrdocs to generate docs from code
steve-downey Oct 26, 2025
dfb7b57
Cleanup more documentation
steve-downey Oct 26, 2025
0de596f
Merge branch 'main' into mrdocs-merge
steve-downey Oct 26, 2025
7873f15
Merge branch 'mrdocs-merge' into mrdocs
steve-downey Oct 26, 2025
0fbb147
Remove upgrade of packages from pip install
steve-downey Oct 26, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,4 @@ compile_commands.json

/docs/html
/docs/latex
/docs/adoc/
16 changes: 15 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,16 @@ $(_build_path)/CMakeCache.txt: | $(_build_path) .gitmodules
-rm compile_commands.json
ln -s $(_build_path)/compile_commands.json

$(_build_path)/compile_commands.json : $(_build_path)/CMakeCache.txt

compile_commands.json: $(_build_path)/compile_commands.json
-rm compile_commands.json
ln -s $(_build_path)/compile_commands.json

TARGET:=all
compile: compile_commands.json
compile: $(_build_path)/CMakeCache.txt ## Compile the project
compile: ## Compile the project
cmake --build $(_build_path) --config $(CONFIG) --target all -- -k 0

compile-headers: $(_build_path)/CMakeCache.txt ## Compile the headers
Expand Down Expand Up @@ -135,7 +143,7 @@ requirements-dev.txt: requirements-dev.in

$(VENV):
$(PYEXECPATH) -m venv $(VENV)
$(PIP) install --upgrade pip setuptools wheel
$(PIP) install pip setuptools wheel
$(PIP) install pip-tools

$(VENV)/$(MARKER): requirements.txt requirements-dev.txt | $(VENV)
Expand Down Expand Up @@ -178,6 +186,12 @@ view-coverage: ## View the coverage report
docs: ## Build the docs with Doxygen
doxygen docs/Doxyfile

.PHONY: mrdocs
mrdocs: ## Build the docs with Doxygen
-rm -rf docs/adoc
cd docs && NO_COLOR=1 mrdocs mrdocs.yml 2>&1 | sed 's/\x1b\[[0-9;]*m//g'
find docs/adoc -name '*.adoc' | xargs asciidoctor

# Help target
.PHONY: help
help: ## Show this help.
Expand Down
24 changes: 24 additions & 0 deletions docs/mrdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# $schema: https://mrdocs.com/docs/mrdocs/develop/_attachments/mrdocs.schema.json
# yaml-language-server: $schema=https://mrdocs.com/docs/mrdocs/develop/_attachments/mrdocs.schema.json

---
source-root: ..
input:
- ../include
exclude:
- ../include/beman/optional/detail
exclude-patterns:
- ../include/beman/optional/detail/**
- ../tests/**
- ../examples/**
includes:
- ../include
file-patterns:
- '*.hpp'
include-symbols:
- 'beman::optional::**'
implementation-defined:
- 'beman::optional::detail'
multipage: true
generator: adoc
output: adoc
Loading