Skip to content

docs: how to build user docs locally #61

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 1 commit into from
May 17, 2024
Merged

docs: how to build user docs locally #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ This repo contains automation scripts and CI configuration to run the scripts.
To run the scripts locally, execute `./ci/<build script>`, where `build script`
is any executable shell script. Override environment variables as necessary.

### Example: Build user documentations:

NEOVIM_DIR=~/neovim-src/ ./ci/user-docu.sh

### Example: Generate the vim-patch report:

VIM_SOURCE_DIR=~/vim-src/ NEOVIM_DIR=~/neovim-src/ ./ci/vimpatch-report.sh
1 change: 1 addition & 0 deletions ci/user-docu.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ source ${BUILD_DIR}/ci/common/common.sh

generate_user_docu() {
require_environment_variable BUILD_DIR "${BASH_SOURCE[0]}" ${LINENO}
require_environment_variable NEOVIM_DIR "${BASH_SOURCE[0]}" ${LINENO}

cd ${NEOVIM_DIR}
make
Expand Down