Skip to content

feat: html concept templates #725

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
merged 3 commits into from
Nov 8, 2024
Merged

feat: html concept templates #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aca2d84
ci: remove info node support warnings
alandefreitas Nov 7, 2024
2747698
feat: html concept templates
alandefreitas Nov 7, 2024
84ac818
test: html golden tests
alandefreitas Nov 7, 2024
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
225 changes: 0 additions & 225 deletions .github/check_info_nodes_support.sh
View file
Open in desktop

This file was deleted.

76 changes: 0 additions & 76 deletions .github/compare_templates.sh
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,13 +763,6 @@ jobs:
limit: 150
update-summary: ${{ runner.os == 'Linux' && 'true' || 'false' }}

- name: Check Info Nodes
if: runner.os == 'Linux'
run: |
set -x
chmod +x .github/check_info_nodes_support.sh
.github/check_info_nodes_support.sh

- name: Create GitHub Package Release
if: ${{ github.event_name == 'push' && (contains(fromJSON('["master", "develop"]'), github.ref_name) || startsWith(github.ref, 'refs/tags/')) }}
uses: softprops/action-gh-release@v2
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ if (MRDOCS_BUILD_TESTS)
endif ()
target_compile_definitions(mrdocs-test PRIVATE -DMRDOCS_TEST_FILES_DIR="${CMAKE_CURRENT_SOURCE_DIR}/test-files")
add_test(NAME mrdocs-unit-tests COMMAND mrdocs-test --unit=true)
foreach (testgenerator IN ITEMS xml adoc)
foreach (testgenerator IN ITEMS xml adoc html)
add_test(NAME mrdocs-golden-tests-${testgenerator}
COMMAND
mrdocs-test
Expand Down
3 changes: 3 additions & 0 deletions share/mrdocs/addons/generator/html/partials/signature/concept.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{{>template-head symbol.template}}

concept {{>declarator-id symbol}} = {{symbol.constraint}}
32 changes: 32 additions & 0 deletions share/mrdocs/addons/generator/html/partials/symbols/concept.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{!-- concept --}}
<div id="{{symbol.id}}">
<div>
<h2>{{>nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}</h2>
{{symbol.doc.brief}}
</div>
<div>
<h3>Synopsis</h3>
<div>
<code>
{{>source dcl=(primary_location symbol)}}
</code>
</div>
<pre class="source-code cpp">
{{>signature/concept symbol=symbol}};
</pre>
</div>
{{#if symbol.doc.description}}
<div>
<h3>Description</h3>
{{symbol.doc.description}}
</div>
{{/if}}
{{#if symbol.doc.see}}
<div>
<h3>See Also</h3>
{{#each symbol.doc.see}}
<p>{{.}}</p>
{{/each}}
</div>
{{/if}}
</div>
Loading
Loading