https://github.com/giswqs/programming-notes
My personal programming notes
https://github.com/giswqs/programming-notes
geopython jupyter jupyterbook linux open-source programming python vscode
Last synced: 3 months ago
JSON representation
My personal programming notes
- Host: GitHub
- URL: https://github.com/giswqs/programming-notes
- Owner: giswqs
- License: mit
- Created: 2022-04-01T23:33:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-02T01:25:04.000Z (almost 4 years ago)
- Last Synced: 2025-02-05T16:48:26.091Z (12 months ago)
- Topics: geopython, jupyter, jupyterbook, linux, open-source, programming, python, vscode
- Language: TeX
- Homepage: https://notes.gishub.org
- Size: 1.67 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Programming Notes
My personal programming notes
## Usage
### Building the book
If you'd like to develop and/or build the Programming Notes 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 `programming-notes/` directory
4. Run `jupyter-book clean programming-notes/` to remove any existing builds
5. Run `jupyter-book build programming-notes/`
A fully-rendered HTML version of the book will be built in `programming-notes/_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/giswqs/programming-notes/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).