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

Servir a documentação em um site próprio (ex., GitHub Pages) #42

Open
rffontenelle opened this issue Nov 7, 2020 · 4 comments
Open

Comments

@rffontenelle
Copy link
Collaborator

Servir a documentação em um site da própria equipe (ex., GitHub Pages) poderia nos permitir ver como ficará a documentação em produção, além de, em épocas de sprint, permitir executar em menos espaço de tempo o script de compilação de documentação e tanto encontrar rapidamente erros de tradução quanto permitir melhor visualização.

@glauesppen
Copy link

Já temos algum template em mente?

@adorilson
Copy link
Contributor

Olá, @glauesppen

Template que você fala é o HTML/CSS?

Se for, isso tá feito. É a o da documentação oficial já.
Se você fizer o clone desse repositório e executar

make venv
source venv/bin/activate
make build
make serve

Vai conseguir servir a documentação na sua máquina.
O que se quer é colocar isso em um servidor na internet.

Deve dar um erro no build, mas só alterar o arquivo Makefile, mudando a linha

BRANCH              := $(shell git branch --show-current)

para

BRANCH              := $(shell git branch)

@glauesppen
Copy link

Oi @adorilson !

Fiquei um pouco confusa entao.. O que @rffontenelle comentou seria para qual finalidade? Queria dar suporte a este repo :)
Obrigada!

@adorilson
Copy link
Contributor

Para essas finalidades que ele citou:

permitir ver como ficará a documentação em produção, além de, em épocas de sprint, permitir executar em menos espaço de tempo o script de compilação de documentação e tanto encontrar rapidamente erros de tradução quanto permitir melhor visualização.

Contudo, eu não sei se isso ainda é realmente necessário (e se tem uma relação custo/beneficio favorável). Antigamente o processo de atualizaço do docs.python.org era manual. Hoje é automática e feita toda noite.

@rffontenelle Qual a sua opinião sobre isso atualmente?

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

No branches or pull requests

3 participants