-
Notifications
You must be signed in to change notification settings - Fork 3
build_antora.sh: patch base-url with permalink #45
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,6 +11,7 @@ | |||||
|
|
||||||
| set -e | ||||||
|
|
||||||
|
|
||||||
| if [ $# -eq 0 ] | ||||||
| then | ||||||
| echo "No playbook supplied, using default playbook" | ||||||
|
|
@@ -22,6 +23,24 @@ fi | |||||
| SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) | ||||||
| cd "$SCRIPT_DIR" | ||||||
|
|
||||||
| if [ -n "${CIRCLE_REPOSITORY_URL:-}" ]; then | ||||||
| account="${CIRCLE_REPOSITORY_URL#*:}" | ||||||
| account="${account%%/*}" | ||||||
| lib=$(basename "$(git rev-parse --show-toplevel)") | ||||||
| repository="${account}/$lib" | ||||||
| sha=${CIRCLE_SHA1} | ||||||
| elif [ -n "${GITHUB_REPOSITORY:-}" ]; then | ||||||
| repository="${GITHUB_REPOSITORY}" | ||||||
| sha=${GITHUB_SHA} | ||||||
| fi | ||||||
|
|
||||||
| if [ -n "${repository}" ] && [ -n "${sha}" ]; then | ||||||
| base_url="https://github.com/${repository}/blob/${sha}" | ||||||
| echo "Setting base-url to $base_url" | ||||||
| cp mrdocs.yml mrdocs.yml.bak | ||||||
| perl -i -pe 's{^\s*base-url:.*$}{base-url: '"$base_url/"'}' mrdocs.yml | ||||||
|
||||||
| perl -i -pe 's{^\s*base-url:.*$}{base-url: '"$base_url/"'}' mrdocs.yml | |
| perl -i -pe 's{^\s*base-url:.*$}{base-url: '"$base_url"'}' mrdocs.yml |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,21 +7,64 @@ | |||||
|
|
||||||
| The following headers are sufficient for most basic uses of the library. | ||||||
|
|
||||||
| * xref:#main[`boost/openmethod.hpp`] to define open-methods and overriders using | ||||||
| * xref:#openmethod[`<boost/openmethod.hpp>`] to define open-methods and overriders using | ||||||
| convenient macros. | ||||||
|
|
||||||
| * xref:#initialize[`boost/openmethod/initialize.hpp`] to initialize the library. | ||||||
| * xref:#initialize[`<boost/openmethod/initialize.hpp>`] to initialize the library. | ||||||
| Typically only included in the translation unit containing `main`. | ||||||
|
|
||||||
| The following headers make it possible to use standard smart pointers in virtual | ||||||
| parameters: | ||||||
|
|
||||||
| * xref:#std_shared_ptr[`boost/openmethod/interop/std_shared_ptr.hpp`] to use | ||||||
| * xref:#std_shared_ptr[`<boost/openmethod/interop/std_shared_ptr.hpp>`] to use | ||||||
| `std::shared_ptr` in virtual parameters. | ||||||
|
|
||||||
| * xref:#std_unique_ptr[`boost/openmethod/interop/std_unique_ptr.hpp`] to use | ||||||
| * xref:#std_unique_ptr[`<boost/openmethod/interop/std_unique_ptr.hpp>`] to use | ||||||
| `std::unique_ptr` in virtual parameters. | ||||||
|
|
||||||
| ## High-level Headers | ||||||
|
|
||||||
| [#core] | ||||||
| ### link:{{BASE_URL}}/include/boost/openmethod/core.hpp[<boost/openmethod/core.hpp>] | ||||||
|
|
||||||
| Defines the main constructs of the library: methods, overriders and virtual | ||||||
| pointers, and mechanisms to implement them. Does not define any public macros | ||||||
| apart from `BOOST_OPENMETHOD_DEFAULT_REGISTRY`, if it is not defined already. | ||||||
|
|
||||||
| [#macros] | ||||||
| ### link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>] | ||||||
|
|
||||||
| Defines the public macros of the library, such as `BOOST_OPENMETHOD`, | ||||||
| `BOOST_OPENMETHOD_CLASSES`, etc. | ||||||
|
|
||||||
| There is little point in including this header directly, as this has the same | ||||||
| effect as including `boost/openmethod.hpp`, which is shorter. | ||||||
|
|
||||||
| [#openmethod] | ||||||
| ### link:{{BASE_URL}}/include/boost/openmethod.hpp[<boost/openmethod.hpp>] | ||||||
|
|
||||||
| Includes `core.hpp` and `macros.hpp`. | ||||||
|
|
||||||
| [#initialize] | ||||||
| ### link:{{BASE_URL}}/include/boost/initialize.hpp[<boost/initialize.hpp>] | ||||||
jll63 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| ### link:{{BASE_URL}}/include/boost/initialize.hpp[<boost/initialize.hpp>] | |
| ### link:{{BASE_URL}}/include/boost/openmethod/initialize.hpp[<boost/openmethod/initialize.hpp>] |
Uh oh!
There was an error while loading. Please reload this page.