Skip to content

Commit

Permalink
add sphinxext-opengraph (#8)
Browse files Browse the repository at this point in the history
* add sphinxext-opengraph

* update

* update

* add sphinxcontrib-external-link

* update

* update poetry files

* update README
  • Loading branch information
shunk031 authored Aug 25, 2023
1 parent 39cd8b6 commit b158960
Show file tree
Hide file tree
Showing 5 changed files with 472 additions and 10 deletions.
11 changes: 3 additions & 8 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,13 @@ jobs:
- name: Install dependencies
run: |
pip install poetry
poetry export -f requirements.txt --output requirements.txt
poetry export --without-hashes -f requirements.txt --output requirements.txt
pip install -r requirements.txt
# # Check external links in the book
# - name: Check external links
# run: |
# jupyter-book build . --builder linkcheck

# Build the book
# Build the book by checking external links.
- name: Build the book
run: |
jupyter-book build .
jupyter-book build --builder linkcheck .
# Push the book's HTML to github-pages
- name: GitHub Pages action
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![deploy-book](https://github.com/shunk031/coloso-python-diffusion-models/actions/workflows/deploy.yaml/badge.svg)](https://github.com/shunk031/coloso-python-diffusion-models/actions/workflows/deploy.yaml)
[![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/shunk031/coloso-python-diffusion-models/blob/main/LICENSE)
![Python](https://img.shields.io/badge/🐍%20Python-3.8-orange)
![Python](https://img.shields.io/badge/🐍%20Python-3.9+-orange)
[![Diffusers](https://img.shields.io/badge/🤗%20Diffusers-0.16.0-orange)](https://github.com/huggingface/diffusers)

<p align="center">
Expand Down Expand Up @@ -76,6 +76,12 @@

- https://github.com/shunk031/coloso-python-diffusion-models/issues

## 🔗 関連リンク

- 講座ページ | リサーチサイエンティスト 北田俊輔 | Coloso. | コロソ。https://coloso.jp/programming/researchscientist-kitada-jp
- Colaboratory へようこそ - Colaboratory https://colab.research.google.com
- Huggingface Diffusers https://huggingface.co/docs/diffusers/index

## License

MIT
11 changes: 11 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,14 @@ html:
sphinx:
config:
language: ja
ogp_site_name: "画像生成AI入門: Pythonによる拡散モデルの理論と実践"
ogp_site_url: "https://shunk031.me/coloso-python-diffusion-models/README.html"
ogp_image: "https://raw.githubusercontent.com/shunk031/coloso-python-diffusion-models/main/assets/logo.png"
ogp_description_length: 200
linkcheck_ignore:
- https://app.diagrams.net/#Uhttps
- https://huggingface.co/docs/diffusers/api
extra_extensions:
- sphinxext.opengraph
- sphinxcontrib.external_link

Loading

0 comments on commit b158960

Please sign in to comment.