Skip to content

Document using this template *without* a splashpage (jupyterbook only) #184

@scottyhq

Description

@scottyhq

It's fairly straightforward to use this template without a splashpage, you'd just need to comment out the top of the build script that deals with rendering the splashpage:

if [ -f "$JSON_FILE" ]; then
rm "$JSON_FILE"
echo "Removed JSON file"
fi
./build_team_yaml.sh
if [ -f "$YAML_FILE" ]; then
echo "Converting yaml to json"
python yaml2json.py "$YAML_FILE" "$JSON_FILE"
fi
if [ -d "../book/_build/html/assets" ]; then
rm -rf ../book/_build/html/assets
echo "Removed jupyterbook assets"
fi
check_success() {
if [[ $? -ne 0 ]]; then
printf "\033[1;31m ERROR \033[0m\n"
exit 1
else
printf "\033[1;32m SUCCESS \033[0m\n"
fi
}
printf "Building the splash page -"
cookiecutter ../. -f --no-input -o ../book/_build
check_success

Also some of the packages in the default environment can be commented out or deleted

# For building the Splashpage
- cookiecutter
# Dependencies of jinja-markdown:
- jinja2>=2.11
- pygments>=2.6.1
- pymdown-extensions>=7.1
- pip:
- jinja-markdown==1.210911

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions