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.

Sign up for GitHub

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

Jump to bottom

Address warnings when building docs #307

Closed
tatiana opened this issue Jun 2, 2023 · 0 comments · Fixed by #374
Closed

Address warnings when building docs #307

tatiana opened this issue Jun 2, 2023 · 0 comments · Fixed by #374
Labels
area:docs Relating to documentation, changes, fixes, improvement good first issue Good for newcomers team/astro-devex
Milestone
1.0.0

Comments

@tatiana
Copy link
Collaborator

tatiana commented Jun 2, 2023

When running:

hatch -e docs run build

We see 207 warnings during the documentation generation:

generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 207 warnings.

The goal with this ticket is to reduce to zero warnings, if possible.
@tatiana tatiana added this to the 1.0.0 milestone Jun 2, 2023
@tatiana tatiana mentioned this issue Jul 22, 2023
Merged
2 tasks
tatiana pushed a commit that referenced this issue Aug 9, 2023
@jlaneve @pre-commit-ci
@harels @tatiana
Update docs structure and add getting started guides (#374)
68e1474 
## Description

<!-- Add a brief but complete description of the change. -->

This PR updates the docs site with a better structure. It also adds
getting started guides for each of the popular ways of running Airflow.

## Related Issue(s)

Closes: #219
Closes: #316 
Closes: #307 

## Breaking Change?

<!-- If this introduces a breaking change, specify that here. -->

## Checklist

- [ ] I have made corresponding changes to the documentation (if
required)
- [ ] I have added tests that prove my fix is effective or that my
feature works

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Harel Shein <[email protected]>
@tatiana tatiana added area:docs Relating to documentation, changes, fixes, improvement and removed documentation labels Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:docs Relating to documentation, changes, fixes, improvement good first issue Good for newcomers team/astro-devex
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Update docs structure and add getting started guides astronomer/astronomer-cosmos
2 participants
@tatiana @harels