Configura Poetry para gerenciar as dependências da documentação. Além de instalar o Sphinx, também adicionei o myst-parser (e o configurei no arquivo conf.py) para suportar documentação escrita em Markdown.
Motivo da escolha do Poetry é que o readthedocs.io suporta o pyproject.toml por padrão, o que torna o uso do Poetry mais fácil, ao contrário do Pipenv, por exemplo. readthedocs.io é onde o manual esta hospedado.
Atualização do README.md virá no próximo PR com uma página de como contribuir na própria documentação.
# Para instalar as dependências:
$ poetry install
# Para rodar um comando dentro de um virtualenv, sem ativá-lo:
$ poetry run <comando>
$ poetry run make html
$ poetry run python
# Para ativar um virtualenv (a partir desse comando, basta seguir o que está no README.md):
$ poetry shell
Configura Poetry para gerenciar as dependências da documentação. Além de instalar o Sphinx, também adicionei o
myst-parser(e o configurei no arquivoconf.py) para suportar documentação escrita em Markdown.Motivo da escolha do Poetry é que o readthedocs.io suporta o
pyproject.tomlpor padrão, o que torna o uso do Poetry mais fácil, ao contrário do Pipenv, por exemplo. readthedocs.io é onde o manual esta hospedado.Atualização do README.md virá no próximo PR com uma página de como contribuir na própria documentação.
Documentação de como instalar o Poetry: https://python-poetry.org/docs/#installation
Principais comandos: