Skip to content

Issue#54 #55

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
Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open

Issue#54 #55

wants to merge 30 commits into from

Conversation

Diego-Espindola
Copy link
Contributor

@Diego-Espindola Diego-Espindola commented Oct 6, 2025 •
edited
Loading

Adiciona workflow de publicação automática da documentação no GitHub Pages

Este PR implementa:

  • Workflow do GitHub Actions para gerar e publicar automaticamente a documentação do projeto no GitHub Pages.
  • Exportação do schema OpenAPI da API FastAPI para ser embutido na documentação.
  • Integração do Sphinx com Redoc para exibir a documentação da API junto com a documentação geral.
  • Sincronização automática do conteúdo do [README.md] da raiz na documentação.
  • Ajustes para garantir que o sumário e títulos fiquem claros e organizados.

Como funciona

  • A cada push na branch main, o workflow:
    • Instala as dependências.
    • Exporta o OpenAPI.
    • Copia o README.md para a pasta de documentação, ajustando o título.
    • Gera a documentação estática com Sphinx.
    • Publica o resultado no GitHub Pages.

Benefícios

@Diego-Espindola
feat(docs): configurar GitHub Actions para publicação no GitHub Pages
72209f6 
- Adicionado script `scripts/export_openapi.py` para exportar o schema OpenAPI
- Criado workflow `.github/workflows/docs.yml` para gerar e publicar docs com Redoc
- Preparado deploy automático da documentação na branch `gh-pages`
@Diego-Espindola
Merge pull request #1 from Diego-Espindola/issue#54
9ed8c3d 
feat(docs): configurar GitHub Actions para publicação no GitHub Pages
@Diego-Espindola
Feat(docs): Adicionado requirementes.txt
2fa1c48
@Diego-Espindola
Merge pull request #2 from Diego-Espindola/issue#54
9743c62 
Feat(docs): Adicionado requirementes.txt
@Diego-Espindola
Update docs.yml
0d127c0
@Diego-Espindola
Update docs.yml
33ddd2e
@Diego-Espindola
feat(docs): documentação automatizada com Sphinx, MyST, Redoc e deplo…
ada398a 
…y via GitHub Actions
@Diego-Espindola
Merge pull request #3 from Diego-Espindola/issue#54
737dca1 
Issue#54
@Diego-Espindola
feat(docs): documentação automatizada com Sphinx, MyST, Redoc e deplo…
a36c949 
…y via GitHub Actions
@Diego-Espindola
Merge pull request #4 from Diego-Espindola/issue#54
004af79 
feat(docs): documentação automatizada com Sphinx, MyST, Redoc e deplo…
@Diego-Espindola
corrigir publish dir
e443595
@Diego-Espindola
Merge branch 'main' into issue#54
443ce1e
@Diego-Espindola
Merge pull request #5 from Diego-Espindola/issue#54
e4b0438 
corrigir publish dir
@Diego-Espindola
update docs.yml
d0ba4e8
@Diego-Espindola
Merge branch 'issue#54' of https://github.com/Diego-Espindola/PyNewsS…
88013d2 
…erver into issue#54
@Diego-Espindola
Merge pull request #6 from Diego-Espindola/issue#54
0328ca7 
Issue#54
@Diego-Espindola
Update docs.yml
57de450
@Diego-Espindola
Update docs.yml
2907483
@Diego-Espindola
Update requirements.txt
2e99e17
@Diego-Espindola
Update requirements.txt
11e56b2
@Diego-Espindola
adicionado o deploy pra ser pelo actions e nao pelo pages
a76804b
@Diego-Espindola
Merge pull request #7 from Diego-Espindola/issue#54
1cb3aca 
adicionado o deploy pra ser pelo actions e nao pelo pages
@Diego-Espindola
Update docs.yml
66709e1
@Diego-Espindola
Update index.md
8525ae5
@Diego-Espindola
Update index.md
9151c5b
@Diego-Espindola
Update docs.yml
3a18c36
@Diego-Espindola
Update docs.yml
08ae4f8
@Diego-Espindola
Update docs.yml
5469b4d
@Diego-Espindola
Update readme.md
85cdd6e
@Diego-Espindola
Merge pull request #8 from Diego-Espindola/main
8c10e62 
Feat(Docs): visual readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Configurar GitHub Actions para publicar documentação da API no GitHub Pages

1 participant

@Diego-Espindola