-
Notifications
You must be signed in to change notification settings - Fork 25
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
build_docs: add Asciidoctor documentation build support #93
base: develop
Are you sure you want to change the base?
Conversation
- enhance build type detection to recognize Asciidoctor documentation - add 'asciidoctor' as a valid build type - implement b2 build command for Asciidoctor documentation with source highlighter - improve variable handling and quoting for better shell script practices
Hey @sdarwin. I was able to successfully change the source highlighter. Before I move on to the other 2 files (windows and linux scripts), how's this strategy? |
When release-tools builds the entire boost bundle, it needs to be capable of building any/all docs, without caring too much if they are asciidoctor, quickbook, etc. They all need to be buildable. The main script which does that is You're adding a code change in I think it's better for So how will "asciidoctor-attribute=source-highlighter=highlight.js" be set? Notice "user-config.jam", which is already in macosdocs.sh. That's a config file that b2 references. Add the new setting into user-config.jam (for all libraries). I believe "user-config.jam" uses a syntax that is very similar to any Jamfile. Therefore, review Jamfiles from any boost repositories, to see examples of syntax. It can't be too difficult to format the setting "asciidoctor-attribute=source-highlighter=highlight.js". If there are difficulties, contact grisumbras or another alliance developers. They are experts in b2. After the build_docs scripts are working, which is a good first step, ultimately How to test release-tools locally: https://github.com/boostorg/release-tools/blob/develop/docs/README.md B2 docs: https://www.bfgroup.xyz/b2/manual/release/index.html |
Is highlight.js a nodejs module? The idea with all the In terms of Create a v4 directory, and a v4/Dockerfile. Include highlight.js in the existing node/nvm section there. For However, here is an idea: asciidoctor won't be a full-fledged type for the moment. Keep the detection logic, but use it to set a new variable asciidoctor_docs="yes", and also set "install_antora_deps" = "yes", whenever asciidoctor is detected. Actually, asciidoctor_docs="yes" won't be used. It can be be set, as a demonstration. The variable "install_antora_deps" will be the one that's relevant. That will trigger this existing section to install npm packages:
Causing npm packages to get installed. Create another separate PR that focuses on |
Resolves boostorg/boostlook#67