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

Add links from source code to github #428

Merged
merged 6 commits into from
Dec 12, 2023
Merged

Add links from source code to github #428

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
ab376ec
Save links to the source in the database
danakj Dec 11, 2023
9359329
Add source links to generated html
danakj Dec 12, 2023
198e940
Use forward slashes in source links
danakj Dec 12, 2023
4376854
Paths can be modified at construction time, not generate time
danakj Dec 12, 2023
fbdc97a
Add options to configure the source url paths
danakj Dec 12, 2023
0bca56e
Add an option to not generate source code links at all
danakj Dec 12, 2023
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
3 changes: 3 additions & 0 deletions .github/workflows/subdoc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
env:
clang_version: 16
installed_clang_version: 14
source_url: "https://github.com/chromium/subspace/blob/main"

steps:
- uses: actions/checkout@v3
Expand Down Expand Up @@ -169,6 +170,8 @@ jobs:
--project-logo logo.png \
--project-md sus/project.md \
--project-name Subspace \
--remove-source-path-prefix $PWD \
--add-source-path-prefix ${source_url} \
/home/runner/work/subspace/subspace/sus

- name: Deploy
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/try.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@ jobs:
env:
clang_version: 16
installed_clang_version: 14
source_url: "https://github.com/chromium/subspace/blob/main"

steps:
- uses: actions/checkout@v3
Expand Down Expand Up @@ -417,6 +418,8 @@ jobs:
--project-logo logo.png \
--project-md sus/project.md \
--project-name Subspace \
--remove-source-path-prefix $PWD \
--add-source-path-prefix ${source_url} \
/home/runner/work/subspace/subspace/sus

bench:
Expand Down
4 changes: 4 additions & 0 deletions subdoc/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ target_sources(subdoc_lib PUBLIC
"lib/gen/generate_record.cc"
"lib/gen/generate_record.h"
"lib/gen/generate_requires.cc"
"lib/gen/generate_source_link.cc"
"lib/gen/generate_source_link.h"
"lib/gen/generate_type.cc"
"lib/gen/generate_type.h"
"lib/gen/generate.cc"
Expand Down Expand Up @@ -136,6 +138,7 @@ if(${SUBSPACE_BUILD_TESTS})
"gen_tests/gen_tests.cc"
"tests/access_unittest.cc"
"tests/aliases_unittest.cc"
"tests/concepts_unittest.cc"
"tests/cpp_version.h"
"tests/doc_attributes_unittest.cc"
"tests/fields_unittest.cc"
Expand All @@ -145,6 +148,7 @@ if(${SUBSPACE_BUILD_TESTS})
"tests/methods_unittest.cc"
"tests/namespaces_unittest.cc"
"tests/records_unittest.cc"
"tests/source_link_unittest.cc"
"tests/styles_unittest.cc"
"tests/type_unittest.cc"
"tests/self_name_replace_unittest.cc"
Expand Down
6 changes: 3 additions & 3 deletions subdoc/gen_tests/function-overloads/n-fn.multiple.0.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@
</div>
<div class="overload-set">
<div class="overload">
<div class="function-signature"><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>() -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#5">source</a></div><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>() -&gt; void</div>
</div>
<div class="overload">
<div class="function-signature"><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>(int) -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#5">source</a></div><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>(int) -&gt; void</div>
</div>
<div class="overload">
<div class="function-signature"><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>(float) -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#5">source</a></div><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>(float) -&gt; void</div>
</div>
</div>
<div class="description long">
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/function-overloads/n-fn.multiple.1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
</div>
<div class="overload-set">
<div class="overload">
<div class="function-signature"><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>(unsigned int) -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#13">source</a></div><span class="function-auto">auto</span> <a class="function-name" href="#">multiple</a>(unsigned int) -&gt; void</div>
</div>
</div>
<div class="description long">
Expand Down
5 changes: 3 additions & 2 deletions subdoc/gen_tests/function-overloads/namespace.n.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
<div class="namespace">
<div class="section overview">
<div class="section-header">
<div class="src rightside"><a href="test.cc#1">source</a></div>
<span>
Namespace
</span>
Expand All @@ -77,7 +78,7 @@
<li class="section-item">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><a class="function-name" href="n-fn.multiple.0.html">multiple</a></div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#5">source</a></div><a class="function-name" href="n-fn.multiple.0.html">multiple</a></div>
</div>
</div>
<div class="description short">
Expand All @@ -87,7 +88,7 @@
<li class="section-item">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><a class="function-name" href="n-fn.multiple.1.html">multiple</a></div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#13">source</a></div><a class="function-name" href="n-fn.multiple.1.html">multiple</a></div>
</div>
</div>
<div class="description short">
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/markdown/N.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<span class="namespace-dots">::</span>
<a class="type-name" href="#">N</a>
</div>
<div class="type-signature"><span class="struct">
<div class="type-signature"><div class="src rightside"><a href="test.cc#10">source</a></div><span class="struct">
struct
</span><span class="type-name">
N
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/markdown/S.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<span class="namespace-dots">::</span>
<a class="type-name" href="#">S</a>
</div>
<div class="type-signature"><span class="struct">
<div class="type-signature"><div class="src rightside"><a href="test.cc#5">source</a></div><span class="struct">
struct
</span><span class="type-name">
S
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/markdown/Syntax.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<span class="namespace-dots">::</span>
<a class="type-name" href="#">Syntax</a>
</div>
<div class="type-signature"><span class="struct">
<div class="type-signature"><div class="src rightside"><a href="test.cc#23">source</a></div><span class="struct">
struct
</span><span class="type-name">
Syntax
Expand Down
3 changes: 2 additions & 1 deletion subdoc/gen_tests/nested-namespace/namespace.outer_namespace.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<div class="namespace">
<div class="section overview">
<div class="section-header">
<div class="src rightside"><a href="test.cc#4">source</a></div>
<span>
Namespace
</span>
Expand Down Expand Up @@ -98,7 +99,7 @@
<li class="section-item">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><a class="function-name" href="outer_namespace-fn.outer.html">outer</a></div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#7">source</a></div><a class="function-name" href="outer_namespace-fn.outer.html">outer</a></div>
</div>
</div>
<div class="description short">
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/nested-namespace/outer_namespace-fn.outer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
</div>
<div class="overload-set">
<div class="overload">
<div class="function-signature"><span class="function-auto">auto</span> <a class="function-name" href="#">outer</a>() -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#7">source</a></div><span class="function-auto">auto</span> <a class="function-name" href="#">outer</a>() -&gt; void</div>
</div>
</div>
<div class="description long">
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/nested-namespace/outer_namespace-inner_namespace-fn.inner.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
</div>
<div class="overload-set">
<div class="overload">
<div class="function-signature"><span class="function-auto">auto</span> <a class="function-name" href="#">inner</a>() -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#22">source</a></div><span class="function-auto">auto</span> <a class="function-name" href="#">inner</a>() -&gt; void</div>
</div>
</div>
<div class="description long">
Expand Down
1 change: 1 addition & 0 deletions subdoc/gen_tests/nested-namespace/outer_namespace-namespace.empty.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<div class="namespace">
<div class="section overview">
<div class="section-header">
<div class="src rightside"><a href="test.cc#15">source</a></div>
<span>
Namespace
</span>
Expand Down
3 changes: 2 additions & 1 deletion subdoc/gen_tests/nested-namespace/outer_namespace-namespace.inner_namespace.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
<div class="namespace">
<div class="section overview">
<div class="section-header">
<div class="src rightside"><a href="test.cc#12">source</a></div>
<span>
Namespace
</span>
Expand All @@ -79,7 +80,7 @@
<li class="section-item">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><a class="function-name" href="outer_namespace-inner_namespace-fn.inner.html">inner</a></div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#22">source</a></div><a class="function-name" href="outer_namespace-inner_namespace-fn.inner.html">inner</a></div>
</div>
</div>
<div class="description short">
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/struct-basic/S.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<span class="namespace-dots">::</span>
<a class="type-name" href="#">S</a>
</div>
<div class="type-signature"><span class="struct">
<div class="type-signature"><div class="src rightside"><a href="test.cc#5">source</a></div><span class="struct">
struct
</span><span class="type-name">
S
Expand Down
4 changes: 2 additions & 2 deletions subdoc/gen_tests/struct-complex/Base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<span class="namespace-dots">::</span>
<a class="type-name" href="#">Base</a>
</div>
<div class="type-signature"><span class="struct">
<div class="type-signature"><div class="src rightside"><a href="test.cc#20">source</a></div><span class="struct">
struct
</span><span class="type-name">
Base
Expand All @@ -80,7 +80,7 @@
<div class="section-items">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><a name="method.BaseMethod"></a><span class="function-auto">auto</span> <a class="function-name" href="Base.html#method.BaseMethod">BaseMethod</a>() -&gt; void</div>
<div class="function-signature"><div class="src rightside"><a href="test.cc#22">source</a></div><a name="method.BaseMethod"></a><span class="function-auto">auto</span> <a class="function-name" href="Base.html#method.BaseMethod">BaseMethod</a>() -&gt; void</div>
</div>
</div>
<div class="description long">
Expand Down
2 changes: 1 addition & 1 deletion subdoc/gen_tests/struct-complex/OtherType.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<span class="namespace-dots">::</span>
<a class="type-name" href="#">OtherType</a>
</div>
<div class="type-signature"><span class="struct">
<div class="type-signature"><div class="src rightside"><a href="test.cc#16">source</a></div><span class="struct">
struct
</span><span class="type-name">
OtherType
Expand Down
Loading