Skip to content

Commit 2f75680

Browse files
carlosfabcarlosfab
committed
nbdev for Github pages
1 parent 7812bac commit 2f75680

File tree

18 files changed

+404
-126
lines changed

18 files changed

+404
-126
lines changed

‎.github/workflows/ci.yml

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎.github/workflows/deploy.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Deploy to GitHub Pages
2+
3+
permissions:
4+
contents: write
5+
pages: write
6+
7+
on:
8+
push:
9+
branches: [ "main", "master" ]
10+
workflow_dispatch:
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps: [uses: fastai/workflows/quarto-ghp@master]

‎MANIFEST.in

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
include settings.ini
2+
include LICENSE
3+
include CONTRIBUTING.md
4+
include README.md
5+
recursive-exclude * __pycache__

‎README.md

Lines changed: 14 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,22 @@
1-
[<img src="assets/evc_banner_wide.png" alt="Especialização em Visão Computacional | https://sigmoidal.ai)" title="Especialização em Visão Computacional | https://sigmoidal.ai/en)"/>](https://sigmoidal.ai/)
1+
# visao-computacional
22

3-
<div align="center">
4-
5-
[![Linkedin Badge](https://img.shields.io/badge/LinkedIn-0077B5?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/carlos-melo-data-science/)](https://www.linkedin.com/in/carlos-melo-data-science/)
6-
[![YouTube Badge](https://img.shields.io/badge/YouTube-FF0000?style=flat-square&logo=youtube&logoColor=white)](https://www.youtube.com/@CarlosMeloSigmoidal)
7-
[![Instagram Badge](https://img.shields.io/badge/Instagram-E4405F?style=flat-square&logo=instagram&logoColor=white)](https://www.instagram.com/carlos_melo.py)
8-
[![Twitter Badge](https://img.shields.io/twitter/follow/:carlos_melo_py)](https://twitter.com/carlos_melo_py)
3+
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
94

10-
</div>
5+
This file will become your README and also the index of your
6+
documentation.
117

12-
# Especialização em Visão Computacional
8+
## Install
139

14-
Este repositório é dedicado à "Especialização em Visão Computacional". Siga os passos abaixo para configurar o ambiente de desenvolvimento local e instalar as dependências utilizadas durante as aulas.
10+
``` sh
11+
pip install visao_computacional
12+
```
1513

16-
## Pré-requisitos
14+
## How to use
1715

18-
* **VSCode** - Editor de código utilizado durante o treinamento. Disponível para Windows, macOS e Linux. [Instalação oficial do VSCode](https://code.visualstudio.com/download)
16+
Fill me in please! Don’t forget code examples:
1917

20-
* **Pyenv** - Ferramenta para gerenciar múltiplas versões do Python. A versão recomendada do Python para este projeto é a `3.11.3`. [Instruções oficiais de instalação do Pyenv](https://github.com/pyenv/pyenv#installation)
18+
``` python
19+
1+1
20+
```
2121

22-
* **Poetry** - Ferramenta de gerenciamento de dependências em Python. [Instruções oficiais de instalação do Poetry](https://python-poetry.org/docs/#installation)
23-
24-
* **Git** - Ferramenta de controle de versão distribuído. [Instruções oficiais de instalação do Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
25-
26-
* **GitHub** - Plataforma de hospedagem de código. É essencial ter uma conta para interagir com os repositórios. [Como criar uma conta no GitHub](https://docs.github.com/pt/get-started/onboarding/getting-started-with-your-github-account)
27-
28-
## Instalação e Configuração
29-
30-
Aqui está um resumo dos passos que você precisa seguir:
31-
32-
1. Clonar o [Repositório Github](https://github.com/carlosfab/visao-computacional) para a sua máquina local e acessar a pasta `visao-computacional`:
33-
34-
```bash
35-
git clone https://github.com/carlosfab/visao-computacional.git
36-
cd visao-computacional
37-
```
38-
39-
2. Configurar o Poetry para criar ambientes virtuais dentro do diretório do projeto.
40-
41-
```bash
42-
poetry config virtualenvs.in-project true
43-
```
44-
45-
3. Configurar a versão `3.11.3` do Python com Pyenv:
46-
47-
```bash
48-
pyenv install 3.11.3
49-
pyenv local 3.11.3
50-
```
51-
52-
4. Instalar as dependências do projeto:
53-
54-
```bash
55-
poetry install
56-
```
57-
58-
5. Ativar o ambiente virtual.
59-
60-
```bash
61-
poetry shell
62-
```
63-
64-
6. Testando sua instalação
65-
66-
Após seguir os passos de instalação e configuração, execute os testes para garantir que tudo está funcionando como esperado:
67-
68-
```bash
69-
task test
70-
```
71-
72-
## Recursos
73-
74-
* [Recursos e Materiais de apoio](https://sigmoidal.ai): Exemplos de materiais de apoio que serão listados aqui para apoiar o conteúdo da Especialização em Visão Computacional.
75-
76-
## Sobre o Instrutor
77-
78-
<p align="left">
79-
Carlos Melo é <strong>Engenheiro de Visão Computacional</strong> com formação em Ciências Aeronáuticas pela Academia da Força Aérea e <strong>Mestrado em Engenharia Aeroespacial</strong> pelo Instituto Tecnológico de Aeronáutica (ITA).
80-
</p>
81-
82-
### Contato
83-
84-
Para dúvidas, sugestões ou feedbacks:
85-
86-
* **Carlos Melo** - [Contato](https://sigmoidal.ai/contato/)
22+
2

‎mkdocs.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎nbs/00_core.ipynb

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# core\n",
8+
"\n",
9+
"> Fill in a module description here"
10+
]
11+
},
12+
{
13+
"cell_type": "code",
14+
"execution_count": null,
15+
"metadata": {},
16+
"outputs": [],
17+
"source": [
18+
"#| default_exp core"
19+
]
20+
},
21+
{
22+
"cell_type": "code",
23+
"execution_count": null,
24+
"metadata": {},
25+
"outputs": [],
26+
"source": [
27+
"#| hide\n",
28+
"from nbdev.showdoc import *"
29+
]
30+
},
31+
{
32+
"cell_type": "code",
33+
"execution_count": null,
34+
"metadata": {},
35+
"outputs": [],
36+
"source": [
37+
"#| export\n",
38+
"def foo(): pass"
39+
]
40+
},
41+
{
42+
"cell_type": "code",
43+
"execution_count": null,
44+
"metadata": {},
45+
"outputs": [],
46+
"source": [
47+
"#| hide\n",
48+
"import nbdev; nbdev.nbdev_export()"
49+
]
50+
}
51+
],
52+
"metadata": {
53+
"kernelspec": {
54+
"display_name": "python3",
55+
"language": "python",
56+
"name": "python3"
57+
}
58+
},
59+
"nbformat": 4,
60+
"nbformat_minor": 4
61+
}

‎nbs/_quarto.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
project:
2+
type: website
3+
4+
format:
5+
html:
6+
theme: cosmo
7+
css: styles.css
8+
toc: true
9+
10+
website:
11+
twitter-card: true
12+
open-graph: true
13+
repo-actions: [issue]
14+
navbar:
15+
background: primary
16+
search: true
17+
sidebar:
18+
style: floating
19+
20+
metadata-files: [nbdev.yml, sidebar.yml]

‎nbs/index.ipynb

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "code",
5+
"execution_count": null,
6+
"metadata": {},
7+
"outputs": [],
8+
"source": [
9+
"#| hide\n",
10+
"from visao_computacional.core import *"
11+
]
12+
},
13+
{
14+
"cell_type": "markdown",
15+
"metadata": {},
16+
"source": [
17+
"# visao-computacional\n",
18+
"\n",
19+
"> Material de Apoio da Especialização em Visão Computacional"
20+
]
21+
},
22+
{
23+
"cell_type": "markdown",
24+
"metadata": {},
25+
"source": [
26+
"This file will become your README and also the index of your documentation."
27+
]
28+
},
29+
{
30+
"cell_type": "markdown",
31+
"metadata": {},
32+
"source": [
33+
"## Install"
34+
]
35+
},
36+
{
37+
"cell_type": "markdown",
38+
"metadata": {},
39+
"source": [
40+
"```sh\n",
41+
"pip install visao_computacional\n",
42+
"```"
43+
]
44+
},
45+
{
46+
"cell_type": "markdown",
47+
"metadata": {},
48+
"source": [
49+
"## How to use"
50+
]
51+
},
52+
{
53+
"cell_type": "markdown",
54+
"metadata": {},
55+
"source": [
56+
"Fill me in please! Don't forget code examples:"
57+
]
58+
},
59+
{
60+
"cell_type": "code",
61+
"execution_count": null,
62+
"metadata": {},
63+
"outputs": [
64+
{
65+
"data": {
66+
"text/plain": [
67+
"2"
68+
]
69+
},
70+
"execution_count": null,
71+
"metadata": {},
72+
"output_type": "execute_result"
73+
}
74+
],
75+
"source": [
76+
"1+1"
77+
]
78+
},
79+
{
80+
"cell_type": "code",
81+
"execution_count": null,
82+
"metadata": {},
83+
"outputs": [],
84+
"source": []
85+
}
86+
],
87+
"metadata": {
88+
"kernelspec": {
89+
"display_name": "python3",
90+
"language": "python",
91+
"name": "python3"
92+
}
93+
},
94+
"nbformat": 4,
95+
"nbformat_minor": 4
96+
}

‎nbs/nbdev.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
project:
2+
output-dir: _docs
3+
4+
website:
5+
title: "visao-computacional"
6+
site-url: "https://carlosfab.github.io/visao-computacional"
7+
description: "Material de Apoio da Especialização em Visão Computacional"
8+
repo-branch: main
9+
repo-url: "https://github.com/carlosfab/visao-computacional"

‎nbs/sidebar.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
website:
2+
sidebar:
3+
contents:
4+
- index.ipynb
5+
- 00_core.ipynb

0 commit comments

Comments
 (0)