-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1c51cb6
commit 9cc545c
Showing
1 changed file
with
1 addition
and
41 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,3 @@ | ||
Produto Tecnológico desenvolvido durante projeto de Mestrado "Novo framework baseado em Python para processamento de biossinais" do Programa em Engenharia Elétrica e Informática Industrial (CPGEI) da UTFPR - Campus Curitiba, sob orientação dos professores Dr. José Jair Alves Mendes Júnior e Dr. Daniel Prado de Campos. | ||
|
||
# Como Gerar Uma Nova Documentação | ||
|
||
1. Pelo terminal entre na pasta onde está localizado o projeto OpenBCI_Python_Framework | ||
2. Inicie um virtual enviroment de python. Se você não possuir o pacote venv do python | ||
instalado globalmente no seu PC você pode rodar o seguinte comando:</br> | ||
<b>Linux:</b> </br> | ||
``` | ||
python3 -m venv venv | ||
``` | ||
<b>Windows:</b> </br> | ||
``` | ||
py -m venv env | ||
``` | ||
3. Entre no ambiente virtual do python do projeto:</br> | ||
<b>Linux:</b> </br> | ||
``` | ||
source venv/bin/activate | ||
``` | ||
<b>Windows:</b> </br> | ||
``` | ||
.\venv\Scripts\activate | ||
``` | ||
4. Instale as bibliotecas do projeto:</br> | ||
<b>Linux/Windows:</b> </br> | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
5. Execute o seguinte comando no terminal:</br> | ||
``` | ||
sphinx-apidoc -o docs . | ||
``` | ||
6. Entre no diretório docs: | ||
``` | ||
cd ./docs | ||
``` | ||
7. Crie o html : | ||
``` | ||
make html | ||
``` | ||
O novo html será gerado. Agora basta abrir o arquivo "OpenBCI_Python_Framework-main/docs/_build/html/index.html" no seu navergador. | ||
Documentação: [https://arthurhauer.github.io/OpenBCI_Python_Framework/](https://arthurhauer.github.io/OpenBCI_Python_Framework/) |