RST-formatted documentation, guides, and related bug fixes #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aholmes
changed the title
aholmes
force-pushed
the
aholmes-add-documentation
branch
from
0cd68bf to
ab0dd49
Compare
aholmes
force-pushed
the
aholmes-add-documentation
branch
from
3a7c9e7 to
1667a5e
Compare
|
Blocked on #165. Correct documentation cannot be written about building an application until the PR is merged. |
This includes configurations for Sphinx and generating Ligare documentation. It also includes a handful of docstring fixes to make Sphinx happy.
This reorganization helps us store documentation in a more hierarchical format. It also avoids us having to type something like `../../../../../source/whatever` to get Sphinx to render and link pages.
* Ligate.AWS (incomplete) * Ligare.GitHub (incomplete) * Ligare.database * Ligare.identity (incomplete) * Ligare.platform (incomplete) * Ligare.testing * Ligare.web
This class is partly a copy of the application builder in Ligare.web, but more generic. This is a precursor to further refactoring and changing Ligare.web to use the Ligare.programming builder.
This is a breaking change to remove the previously deprecated `create_app` and `App[T].create_app` functions. Use `ApplicationBuilder`.
…rogramming`. This change is necessary to allow non-web applications like CLI apps.
type generic var binding.
aholmes
force-pushed
the
aholmes-add-documentation
branch
from
3e82865 to
231415f
Compare
applications error free when using pyright.
* Move the builder exception types from Ligare.web to Ligare.programming * Guard against loading Ligare.AWS if it's not installed * Add toml to Ligare.programming's dependencies
web Config type by default. Also remove the `with_root_config_type` method to simplify the builder and prevent misuse. This change is needed so application authors don't need to do this, and this is safe because web applications all use the web Config type as their root config.
This allows web applications to rely on the config system to set the application name rather than relying on hard-coding it.
When the Swagger URL is `/` or ``, the application crashes on any request. This is because Connxeion registers conflicting Blueprint URLs for anything in the OpenAPI spec by using the same base URL as the Swagger URL. This is not resolved by changing the base path in the OpenAPI spec, because Connexion will use that base path instead. Also removed some obsolete and unused code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.