Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 [#521] Update docs for setup-config #527

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

stevenbal
Copy link
Collaborator

Fixes #521

Changes

  • Update docs for setup-config

@stevenbal stevenbal force-pushed the feature/521-setup-config-docs branch from a834de0 to 1d26001 Compare February 17, 2025 13:27
changes are now rolled back on failure in a step, so some assertions were no longer correct
because django.setup is run when building documentation now, we need to have these packages installed as well because we use postgis
@stevenbal stevenbal force-pushed the feature/521-setup-config-docs branch from 1d26001 to 9117045 Compare February 17, 2025 13:40
----------------------

Create or update the (single) YAML configuration file with your settings:
.. FIXME these can currently only be included manually, because these docs are built in
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if there is a better way to do this, unless we want to give Objecttypes its own RTD page

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's good for now
Not sure if we want a separate RTD and separate issue tracker for Objecttypes

Copy link
Collaborator

@annashamray annashamray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice help texts and descriptions!

----------------------

Create or update the (single) YAML configuration file with your settings:
.. FIXME these can currently only be included manually, because these docs are built in
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's good for now
Not sure if we want a separate RTD and separate issue tracker for Objecttypes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rewrite setup_configuration documentation with YAML example directive
2 participants