Skip to content

Commit

Permalink
Add debug ls all generated docs files and fix docs urls
Browse files Browse the repository at this point in the history
  • Loading branch information
BurnySc2 committed Jan 5, 2025
1 parent 75cfc02 commit 306548b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 6 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -388,10 +388,8 @@ jobs:
cd docs_generate
uv run sphinx-build -a -E -b html . ../docs
- name: Remove files unrelated to docs
run: |
rm -rf data dockerfiles docs_generate examples sc2 test
rm uv.lock
- name: Debug-list all generated files
run: sudo apt-get install tree && tree

- name: Publish to Github Pages
if: github.ref == 'refs/heads/develop' && github.event_name == 'push'
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ mini_games/
.coverage
/htmlcov

/docs
docs/

.pyre
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ An easy-to-use library for writing AI Bots for StarCraft II in Python 3. The ult

**This library (currently) covers only the raw scripted interface.** At this time I don't intend to add support for graphics-based interfaces.

The [documentation can be found here](https://burnysc2.github.io/python-sc2/docs/index.html).
The [documentation can be found here](https://burnysc2.github.io/python-sc2/index.html).
For bot authors, looking directly at the files in the [sc2 folder](/sc2) can also be of benefit: bot_ai.py, unit.py, units.py, client.py, game_info.py and game_state.py. Most functions in those files have docstrings, example usages and type hinting.

I am planning to change this fork more radically than the main repository, for bot performance benefits and to add functions to help new bot authors. This may break older bots in the future, however I try to add deprecation warnings to give a heads up notification. This means that the [video tutorial made by sentdex](https://pythonprogramming.net/starcraft-ii-ai-python-sc2-tutorial/) is outdated and does no longer directly work with this fork.
Expand Down

0 comments on commit 306548b

Please sign in to comment.