Skip to content

Commit

Permalink
Switch to pdoc (#856)
Browse files Browse the repository at this point in the history
* Fix webpage links to reduce the redirect count

* Switch to pdoc

* Add inventory (objects.inv)
  • Loading branch information
davfsa authored Dec 23, 2021
1 parent c409218 commit 692f2d2
Show file tree
Hide file tree
Showing 114 changed files with 4,610 additions and 6,606 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ jobs:
- name: Build pages
run: |
pip install nox
nox -s pages
nox -s pdoc
- name: Upload artifacts
if: github.event_name != 'release'
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<a href="https://codeclimate.com/github/hikari-py/hikari/test_coverage"><img height="20" alt="Test coverage" src="https://api.codeclimate.com/v1/badges/f95070b25136a69b0589/test_coverage"></a>
<br>
<a href="https://discord.gg/Jx4cNGG"><img height="20" alt="Discord invite" src="https://discord.com/api/guilds/574921006817476608/widget.png"></a>
<a href="https://hikari-py.dev/hikari"><img height="20" alt="Documentation status" src="https://img.shields.io/badge/documentation-up-00FF00.svg"></a>
<a href="https://www.hikari-py.dev/hikari"><img height="20" alt="Documentation status" src="https://img.shields.io/badge/documentation-up-00FF00.svg"></a>
</p>

An opinionated, static typed Discord microframework for Python3 and asyncio that supports Discord's V8 REST API and
Expand Down Expand Up @@ -60,9 +60,9 @@ bot = hikari.GatewayBot(intents=hikari.Intents.ALL, token="...")

The above example would enable all intents, thus enabling events relating to member presences to be received
(you'd need to whitelist your application first to be able to start the bot if you do this).
[Other options also exist](https://hikari-py.dev/hikari/impl/bot.html#hikari.impl.bot.GatewayBot) such as
[customising timeouts for requests](https://hikari-py.dev/hikari/config.html#hikari.config.HTTPSettings.timeouts)
and [enabling a proxy](https://hikari-py.dev/hikari/config.html#hikari.config.ProxySettings).
[Other options also exist](https://www.hikari-py.dev/hikari/impl/bot.html#hikari.impl.bot.GatewayBot) such as
[customising timeouts for requests](https://www.hikari-py.dev/hikari/config.html#hikari.config.HTTPSettings.timeouts)
and [enabling a proxy](https://www.hikari-py.dev/hikari/config.html#hikari.config.ProxySettings).

Also note that you could pass extra options to `bot.run` during development, for example:

Expand All @@ -77,7 +77,7 @@ bot.run(
)
```

[Many other helpful options](https://hikari-py.dev/hikari/impl/bot.html#hikari.impl.bot.GatewayBot.run)
[Many other helpful options](https://www.hikari-py.dev/hikari/impl/bot.html#hikari.impl.bot.GatewayBot.run)
exist for you to take advantage of if you wish.

Events are determined by the type annotation on the event parameter, or alternatively as a type passed to the
Expand Down
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ async-timeout==4.0.2 # Used for timeouts in some test cases.
# DOCUMENTATION #
#################

pdoc3==0.10.0
pdoc==8.0.1
sphobjinv==2.1

#################
Expand Down
3 changes: 3 additions & 0 deletions docs/assets/crates.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/discord.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/home.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 0 additions & 23 deletions docs/body.mako

This file was deleted.

54 changes: 0 additions & 54 deletions docs/config.mako

This file was deleted.

Loading

0 comments on commit 692f2d2

Please sign in to comment.