add new page for user guide with description for all methods in the l… #138
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Sphinx Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout do código | |
| uses: actions/checkout@v4 | |
| - name: Configurar Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - name: Gerar arquivo de versão | |
| run: echo "0.0.0-dev" > VERSION.txt | |
| - name: Instalar dependências | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install . | |
| pip install sphinx pydata_sphinx_theme sphinx-rtd-theme \ | |
| sphinx-prompt sphinx_copybutton sphinxext-opengraph \ | |
| matplotlib sphinxcontrib-sass sphinx_remove_toctrees \ | |
| sphinx_design numpydoc sphinx_sitemap | |
| - name: Conferir pacotes instalados | |
| run: | | |
| pip list | |
| pip show mlquantify | |
| python -c "import mlquantify; print(mlquantify.__file__)" | |
| - name: Construir documentação | |
| run: | | |
| sphinx-build docs/source docs/build/html | |
| - name: Publicar no GitHub Pages | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/build/html | |
| clean: true |