Skip to content

Commit

Permalink
Update links to new documentation
Browse files Browse the repository at this point in the history
This is related to PR2257 of sopel-irc/sopel repo.

See also: sopel-irc/sopel#2257
  • Loading branch information
Exirel committed May 2, 2022
1 parent dff6eec commit 1753bd8
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 17 deletions.
2 changes: 1 addition & 1 deletion _appendices/phenny-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ These are likely to affect many or all plugins and deployments.
### Minor issues
These only affect a small number of plugins, and/or will fail gracefully

* Phenny's `last_seen_uri` and `seen` are replaced by Sopel's [memory system]({{ site.docs }}bot.html#sopel.bot.Sopel.memory). Plugins using them will likely still work, but may not interoperate with newer plugins as expected.
* Phenny's `last_seen_uri` and `seen` are replaced by Sopel's [memory system]({{ site.docs }}package/bot.html#sopel.bot.Sopel.memory). Plugins using them will likely still work, but may not interoperate with newer plugins as expected.
* `phenny.stats` will be an empty dict, which will negatively impact any plugin which uses it. This is likely limited to the `.stats` command in Phenny's `info` plugin.
* Imports of `icao` are broken, as `icao.py` is not included in Sopel. This likely only breaks phenny's weather plugin, the functionality of which is replaced and improved in the third-party PyPI package [sopel-modules.weather](https://pypi.org/projects/sopel-modules.weather/).
* Imports of `bot` and `irc` are broken. There is not necessarily a simple solution, but the only plugin this is likely to affect is `reload`, the functionality of which is replaced and improved in Sopel.
Expand Down
16 changes: 8 additions & 8 deletions _upgrading/sopel-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,9 @@ release the migration as part of your next version bump. The choice is yours;
we just provide the tools you need to get started.

[commit-adding-nick-class]: https://github.com/sopel-irc/sopel/commit/f8ca0b9
[docs-db-get-channel-slug]: /docs/db.html#sopel.db.SopelDB.get_channel_slug
[docs-identifier-lower]: /docs/api.html#sopel.tools.Identifier._lower
[docs-identifier-lower-swapped]: /docs/api.html#sopel.tools.Identifier._lower_swapped
[docs-db-get-channel-slug]: /docs/package/db.html#sopel.db.SopelDB.get_channel_slug
[docs-identifier-lower]: /docs/package/tools/identifiers.html#sopel.tools.identifiers.Identifier._lower
[docs-identifier-lower-swapped]: /docs/package/tools/identifiers.html#sopel.tools.identifiers.Identifier._lower_swapped

### Accessing the database

Expand All @@ -247,11 +247,11 @@ to update your plugin's documentation to warn users that non-SQLite databases
haven't been tested, or make sure the plugin is marked as compatible with Sopel
<7.0 only until it can be tested and/or updated.

[docs-db]: /docs/db.html
[docs-db-connect]: /docs/db.html#sopel.db.SopelDB.connect
[docs-db-execute]: /docs/db.html#sopel.db.SopelDB.execute
[docs-db-get_uri]: /docs/db.html#sopel.db.SopelDB.get_uri
[docs-db-session]: /docs/db.html#sopel.db.SopelDB.session
[docs-db]: /docs/package/db.html
[docs-db-connect]: /docs/package/db.html#sopel.db.SopelDB.connect
[docs-db-execute]: /docs/package/db.html#sopel.db.SopelDB.execute
[docs-db-get_uri]: /docs/package/db.html#sopel.db.SopelDB.get_uri
[docs-db-session]: /docs/package/db.html#sopel.db.SopelDB.session

### Managing URL callbacks

Expand Down
17 changes: 11 additions & 6 deletions _usage/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ brackets, that's the default setting, and you can just hit enter to keep it.
When asked for the channels to connect to, enter them separated by commas
(e.g. `#spam,#eggs,#cheese`) This wizard doesn't cover every option, only the
ones which are needed to get the bot running. The core config settings are all
[documented]({{ site.docs }}config.html#the-core-configuration-section),
if you want to make other tweaks.
[documented]({{ site.docs }}configuration.html), if you want to make other
tweaks.

Finally, it will ask you about configuration settings for plugins. This will
automatically detect what plugins you have available, and run their
Expand Down Expand Up @@ -151,7 +151,12 @@ Of course, you can also write your own custom plugins! Check out the

Most IRC networks have a service that allows you to authenticate yourself as
the owner of a username. This is configurable in Sopel with these settings:
[`auth_method`]({{ site.docs }}config.html#sopel.config.core_section.CoreSection.auth_method),
[`auth_password`]({{ site.docs }}config.html#sopel.config.core_section.CoreSection.auth_password),
[`auth_target`]({{ site.docs }}config.html#sopel.config.core_section.CoreSection.auth_target),
and [`auth_username`]({{ site.docs }}config.html#sopel.config.core_section.CoreSection.auth_username).
[`auth_method`]({{ site.docs }}package/config/core_section.html#sopel.config.core_section.CoreSection.auth_method),
[`auth_password`]({{ site.docs }}package/config/core_section.html#sopel.config.core_section.CoreSection.auth_password),
[`auth_target`]({{ site.docs }}package/config/core_section.html#sopel.config.core_section.CoreSection.auth_target),
and [`auth_username`]({{ site.docs }}package/config/core_section.html#sopel.config.core_section.CoreSection.auth_username).

You can read more about [authentication configuration](config-auth) in the
documentation.

[config-auth] /docs/configuration.html#authentication
4 changes: 2 additions & 2 deletions _usage/per-channel-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ plugin (while still allowing `.duck`). Details for each option below.

The `disable_plugins` option is a simple comma-separated list of plugin names,
just like [`core.enable`]({{ site.docs
}}config.html#sopel.config.core_section.CoreSection.enable) or
}}package/config/core_section.html#sopel.config.core_section.CoreSection.enable) or
[`core.exclude`]({{ site.docs
}}config.html#sopel.config.core_section.CoreSection.exclude).
}}package/config/core_section.html#sopel.config.core_section.CoreSection.exclude).

### `disable_commands`

Expand Down

0 comments on commit 1753bd8

Please sign in to comment.