Skip to content

Commit

Permalink
update files
Browse files Browse the repository at this point in the history
  • Loading branch information
janash committed Nov 25, 2024
1 parent f3ca5ca commit 6bb682a
Show file tree
Hide file tree
Showing 11 changed files with 277 additions and 197 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
python-version: [3.8]
python-version: [3.12]
steps:
- uses: actions/checkout@v2

Expand Down
28 changes: 27 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,30 @@ cython_debug/

*/_build/

*/.ipynb_checkpoints/
*/.ipynb_checkpoints/

# Julia stuff - from https://github.com/github/gitignore/blob/main/Julia.gitignore
# Files generated by invoking Julia with --code-coverage
*.jl.cov
*.jl.*.cov

# Files generated by invoking Julia with --track-allocation
*.jl.mem

# System-specific files and directories generated by the BinaryProvider and BinDeps packages
# They contain absolute paths specific to the host computer, and so should not be committed
deps/deps.jl
deps/build.log
deps/downloads/
deps/usr/
deps/src/

# Build artifacts for creating documentation generated by the Documenter package
docs/build/
docs/site/

# File generated by Pkg, the package manager, based on a corresponding Project.toml
# It records a fixed state of all packages used by the project. As such, it should not be
# committed for packages, but should be committed for applications that require a static
# environment.
Manifest.toml
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

BSD License

Copyright (c) 2021, Jessica A. Nash
Copyright (c) 2024, The Molecular Sciences Software Institute and Lesson Authors
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
9 changes: 9 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

.PHONY: book

html:
jupyter-book build book/

clean: book/_build
echo "Removing everything under _build"
rm -rf book/_build
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ This is a Jupyter book template for molssi workshops

### Building the book

If you'd like to develop on and build the Scientific Visualization using Python book, you should:
If you'd like to develop on and build this book, you should:

- Clone this repository and run
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
- (Recommended) Remove the existing `book/_build/` directory
- Run `jupyter-book build book/`
- Run `make html` from the root of the repository

A fully-rendered HTML version of the book will be built in `book/_build/html/`.

Expand All @@ -28,7 +28,7 @@ This will automatically push your build to the `gh-pages` branch. More informati

## Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/janash/molssi_python_visualization/graphs/contributors).
We welcome and recognize all contributions.

## Credits

Expand Down
4 changes: 4 additions & 0 deletions book/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ html:
use_repository_button: true
google_analytics_id: G-FHKVGE8HKZ

extra_css:
- https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.6.0/css/fontawesome.min.css
- https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css

sphinx:
config:
html_js_files:
Expand Down
Loading

0 comments on commit 6bb682a

Please sign in to comment.