https://github.com/abinit/abipy_book

https://github.com/abinit/abipy_book

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/abinit/abipy_book
• Owner: abinit
• License: mit
• Created: 2021-07-07T20:36:16.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T17:38:36.000Z (24 days ago)
• Last Synced: 2024-10-27T19:21:12.127Z (24 days ago)
• Language: Jupyter Notebook
• Homepage: https://abinit.github.io/abipy_book/
• Size: 19.2 MB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AbiPy Book

This cookiecutter creates a simple boilerplate for a Jupyter Book.

## Usage

### Building the book

If you'd like to develop and/or build the AbiPy Book book, you should:

1. Clone this repository

2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)

3. (Optional) Edit the books source files located in the `abipy book/` directory

4. Run `jupyter-book clean abipy_book/` to remove any existing builds

5. Run `jupyter-book build abipy_book/`

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

### Hosting the book

Please see the [Jupyter Book documentation](https://jupyterbook.org/publish/web.html) to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.

For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](https://github.com/executablebooks/cookiecutter-jupyter-book) includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose `github` for the `include_ci` cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the `gh-pages` branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.

## Contributors

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

## Credits

This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).