Skip to content

Commit

Permalink
fix(docs): updates sphinx version and other dependencies (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
pallabpain authored Mar 25, 2024
1 parent 5fb1bbe commit c6a8116
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 53 deletions.
16 changes: 8 additions & 8 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ jobs:
- name: Build Documentation
run: pipenv run python3 -m sphinx -M html docs/source docs/output

- name: Deploy gh-pages
if: github.repository == 'rapyuta-robotics/rapyuta-io-cli' && github.event_name == 'push'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/output/html
cname: cli.rapyuta.io
force_orphan: true
# - name: Deploy gh-pages
# if: github.repository == 'rapyuta-robotics/rapyuta-io-cli' && github.event_name == 'push'
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./docs/output/html
# cname: cli.rapyuta.io
# force_orphan: true
6 changes: 3 additions & 3 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ verify_ssl = true

[dev-packages]
pipenv-setup = "==3.1.1"
sphinx = "==4.2.0"
sphinx-click = "==3.0.1"
furo = "==2021.10.9"
sphinx = ">=5.0.0"
sphinx-click = ">=3.0.1"
furo = ">=2021.10.9"

[packages]
riocli = {path = "."}
Expand Down
87 changes: 46 additions & 41 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
autosummary_generate = True # Turn on sphinx.ext.autosummary
source_suffix = '.rst'
master_doc = 'index'
language = None
language = 'en'
exclude_patterns = []
todo_include_todos = False

Expand Down

0 comments on commit c6a8116

Please sign in to comment.