diff --git a/README.md b/README.md index e31c00b46b..cb3c78204e 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ py -3 -m pip install -U hikari ## Bots Hikari provides two different default bot implementations to suit your needs: -- [GatewayBot](#GatewayBot) -- [RESTBot](#RESTBot) +- [GatewayBot](#gatewaybot) +- [RESTBot](#restbot) ### GatewayBot diff --git a/docs/conf.py b/docs/conf.py index 7988ec98d6..b61730b540 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,16 +57,22 @@ "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "sphinx.ext.mathjax", - # Docs generation - "autoapi.extension", - "numpydoc", + # Our extensions "myst_parser", - # Misc "sphinxext.opengraph", "sphinx_copybutton", "sphinxcontrib.towncrier.ext", ] +if os.getenv("SKIP_REFERENCE_DOCS") is None: + extensions.extend( + ( + "autoapi.extension", + "numpydoc", + ) + ) + + templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] diff --git a/hikari/api/rest.py b/hikari/api/rest.py index 1f9073611a..e638d8f649 100644 --- a/hikari/api/rest.py +++ b/hikari/api/rest.py @@ -2738,6 +2738,7 @@ async def set_my_user_application_role_connection( Depending on the time of the previously created application role records through `set_application_role_connection_metadata_records`, this mapping should contain those keys to the valid type of the record: + - `INTEGER_X`: An `int`. - `DATETIME_X`: A `datetime.datetime` object. - `BOOLEAN_X`: A `bool`. diff --git a/pipelines/sphinx.nox.py b/pipelines/sphinx.nox.py index 811292ed22..7736c639b0 100644 --- a/pipelines/sphinx.nox.py +++ b/pipelines/sphinx.nox.py @@ -36,6 +36,9 @@ @nox.session(reuse_venv=True) def sphinx(session: nox.Session): """Generate docs using sphinx.""" + if "--no-refs" in session.posargs: + session.env["SKIP_REFERENCE_DOCS"] = "1" + if not os.path.exists(config.ARTIFACT_DIRECTORY): os.mkdir(config.ARTIFACT_DIRECTORY)