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.

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

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

Open
scottyhq opened this issue Aug 6, 2024 · 2 comments
Open

Comments

@scottyhq
Copy link
Contributor

scottyhq commented Aug 6, 2024

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

@jomey
Copy link
Contributor

jomey commented Aug 6, 2024

Note that you either need to keep the method definition on line #24-31 or remove the call to the method on line 42:

@scottyhq
Copy link
Contributor Author

scottyhq commented Aug 6, 2024

Also, if not interested in the default content in this jupyterbook note that there are alternative templates which you might find simpler:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants