Skip to content

Commit 9322aef

Browse files
uvidyadharanuvidyadharan
committed
First Commit
0 parents  commit 9322aef

File tree

81 files changed

+3053
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+3053
-0
lines changed

‎.devcontainer/Dockerfile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
FROM python:3.9.18-bullseye
2+
WORKDIR /app
3+
COPY . .
4+
RUN apt-get update && apt-get install -y texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra latexmk texlive-lang-greek texlive-luatex texlive-xetex texlive-fonts-extra dvipng librsvg2-bin git fonts-roboto
5+
RUN pip install -r docs/requirements.txt

‎.devcontainer/devcontainer.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "Dockerfile",
3+
"build": {
4+
"context": "..",
5+
"dockerfile": "Dockerfile"
6+
},
7+
"customizations": {
8+
"vscode": {
9+
"extensions": [
10+
"lextudio.restructuredtext",
11+
"lextudio.restructuredtext-pack",
12+
"trond-snekvik.simple-rst",
13+
"ms-python.python"
14+
]
15+
}
16+
}
17+
}

‎.github/workflows/artifact-management.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: "Artifact Management"
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: '15 8 1 * *'
7+
8+
jobs:
9+
delete-artifacts:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: dscabsa/purge-artifacts-action@v2
13+
with:
14+
token: ${{ secrets.GITHUB_TOKEN }}
15+
expire-in: 7days
16+
17+

‎.github/workflows/link-check.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "Link Check"
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: '0 */12 * * *'
7+
8+
jobs:
9+
link-check:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout Repository
13+
uses: actions/checkout@v3
14+
15+
- name: Python Setup
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: 3.9
19+
cache: 'pip'
20+
21+
- name: Python Install Dependencies
22+
run: pip install -r docs/requirements.txt
23+
24+
- name: link-check
25+
run: make -C docs/ linkcheck SPHINXOPTS="-W --keep-going -n -q"
26+
27+
- name: Arhive Log
28+
if: ${{ failure() }}
29+
uses: actions/upload-artifact@v2
30+
env:
31+
PR_NUMBER: ${{ github.event.number }}
32+
ID: ${{ github.run_attempt }}
33+
with:
34+
name: LINKCHECK-${{ env.PR_NUMBER }}-${{ env.ID }}
35+
path: docs/build/linkcheck/output.txt
36+
retention-days: 7

‎.github/workflows/pull-request.yaml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: "Pull Request Docs Check"
2+
3+
on:
4+
- pull_request
5+
6+
jobs:
7+
build-pdf:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout Repository
11+
uses: actions/checkout@v3
12+
13+
- name: Refresh Packages
14+
run: sudo apt-fast -y update
15+
16+
- name: Install Dependencies
17+
run: xargs -a dependencies sudo apt-fast install -y
18+
19+
- name: Python Setup
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: 3.9
23+
cache: 'pip'
24+
25+
- name: Python Install Dependencies
26+
run: pip install -r docs/requirements.txt
27+
28+
- name: Build PDF
29+
env:
30+
SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
31+
run: make -C docs/ latexpdf
32+
33+
- name: Archive PDF
34+
env:
35+
PR_NUMBER: ${{ github.event.number }}
36+
ID: ${{ github.run_attempt }}
37+
uses: actions/upload-artifact@v3
38+
with:
39+
name: FTCDOCS-PDF
40+
path: |
41+
docs/build/latex/*.pdf
42+
FTCDOCS-PR-${{ env.PR_NUMBER }}-${{ env.ID }}
43+
if-no-files-found: error
44+
45+
build-html:
46+
runs-on: ubuntu-latest
47+
steps:
48+
- name: Checkout Repository
49+
uses: actions/checkout@v3
50+
51+
- name: Refresh Packages
52+
run: sudo apt-fast -y update
53+
54+
- name: Python Setup
55+
uses: actions/setup-python@v4
56+
with:
57+
python-version: 3.9
58+
cache: 'pip'
59+
60+
- name: Python Install Dependencies
61+
run: pip install -r docs/requirements.txt
62+
63+
- name: Build Site
64+
env:
65+
SPHINXOPTS: "-D html_context.commit=${{ github.sha }} -D version=latest -A display_github=true -A github_user=${{ github.repository_owner }} -A github_repo=${{ github.event.repository.name }} -A github_version=${{ github.ref_name }} -A conf_py_path=/docs/source/"
66+
run: make -C docs/ html
67+
68+
- name: Archive Site
69+
uses: actions/upload-artifact@v3
70+
with:
71+
name: FTCDOCS-HTML
72+
path: 'docs/build/html'
73+
if-no-files-found: error
74+
75+
spelling-check:
76+
runs-on: ubuntu-latest
77+
steps:
78+
- name: Checkout Repository
79+
uses: actions/checkout@v3
80+
81+
- uses: reviewdog/action-misspell@v1
82+
with:
83+
locale: "US"
84+
reporter: "github-check"
85+
86+
link-check:
87+
runs-on: ubuntu-latest
88+
steps:
89+
- name: Checkout Repository
90+
uses: actions/checkout@v3
91+
92+
- name: Python Setup
93+
uses: actions/setup-python@v4
94+
with:
95+
python-version: 3.9
96+
cache: 'pip'
97+
98+
- name: Python Install Dependencies
99+
run: pip install -r docs/requirements.txt
100+
101+
- name: link-check
102+
run: make -C docs/ linkcheck SPHINXOPTS="-W --keep-going -n -q"
103+
104+
- name: Archive Log
105+
if: ${{ failure() }}
106+
uses: actions/upload-artifact@v2
107+
env:
108+
PR_NUMBER: ${{ github.event.number }}
109+
ID: ${{ github.run_attempt }}
110+
with:
111+
name: LINKCHECK
112+
path: docs/build/linkcheck/output.txt
113+
retention-days: 7
114+
115+
image-check:
116+
runs-on: ubuntu-latest
117+
steps:
118+
- name: Checkout Repository
119+
uses: actions/checkout@v3
120+
121+
- name: Python Setup
122+
uses: actions/setup-python@v4
123+
with:
124+
python-version: 3.9
125+
126+
- name: Python Install Dependencies
127+
run: pip install -r docs/requirements.txt
128+
129+
- name: image-check
130+
run: make -C docs/ imagecheck

‎.gitignore‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
2+
# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
3+
# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks
4+
5+
### JupyterNotebooks ###
6+
# gitignore template for Jupyter Notebooks
7+
# website: http://jupyter.org/
8+
9+
.ipynb_checkpoints
10+
*/.ipynb_checkpoints/*
11+
12+
# IPython
13+
profile_default/
14+
ipython_config.py
15+
16+
# Remove previous ipynb_checkpoints
17+
# git rm -r .ipynb_checkpoints/
18+
19+
### VIM
20+
*.swp
21+
*.swo
22+
23+
### Python ###
24+
# Byte-compiled / optimized / DLL files
25+
__pycache__/
26+
*.py[cod]
27+
*$py.class
28+
29+
# C extensions
30+
*.so
31+
32+
# Distribution / packaging
33+
.Python
34+
build/
35+
develop-eggs/
36+
dist/
37+
downloads/
38+
eggs/
39+
.eggs/
40+
lib/
41+
lib64/
42+
parts/
43+
sdist/
44+
var/
45+
wheels/
46+
share/python-wheels/
47+
*.egg-info/
48+
.installed.cfg
49+
*.egg
50+
MANIFEST
51+
52+
# PyInstaller
53+
# Usually these files are written by a python script from a template
54+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
55+
*.manifest
56+
*.spec
57+
58+
# Installer logs
59+
pip-log.txt
60+
pip-delete-this-directory.txt
61+
62+
# Unit test / coverage reports
63+
htmlcov/
64+
.tox/
65+
.nox/
66+
.coverage
67+
.coverage.*
68+
.cache
69+
nosetests.xml
70+
coverage.xml
71+
*.cover
72+
*.py,cover
73+
.hypothesis/
74+
.pytest_cache/
75+
cover/
76+
77+
# Translations
78+
*.mo
79+
*.pot
80+
81+
# Django stuff:
82+
*.log
83+
local_settings.py
84+
db.sqlite3
85+
db.sqlite3-journal
86+
87+
# Flask stuff:
88+
instance/
89+
.webassets-cache
90+
91+
# Scrapy stuff:
92+
.scrapy
93+
94+
# Sphinx documentation
95+
docs/_build/
96+
97+
# PyBuilder
98+
.pybuilder/
99+
target/
100+
101+
# Jupyter Notebook
102+
103+
# IPython
104+
105+
# pyenv
106+
# For a library or package, you might want to ignore these files since the code is
107+
# intended to run in multiple environments; otherwise, check them in:
108+
# .python-version
109+
110+
# pipenv
111+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
112+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
113+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
114+
# install all needed dependencies.
115+
#Pipfile.lock
116+
117+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
118+
__pypackages__/
119+
120+
# Celery stuff
121+
celerybeat-schedule
122+
celerybeat.pid
123+
124+
# SageMath parsed files
125+
*.sage.py
126+
127+
# Environments
128+
.env
129+
.venv
130+
env/
131+
venv/
132+
ENV/
133+
env.bak/
134+
venv.bak/
135+
136+
# Spyder project settings
137+
.spyderproject
138+
.spyproject
139+
140+
# Rope project settings
141+
.ropeproject
142+
143+
# mkdocs documentation
144+
/site
145+
146+
# mypy
147+
.mypy_cache/
148+
.dmypy.json
149+
dmypy.json
150+
151+
# Pyre type checker
152+
.pyre/
153+
154+
# pytype static type analyzer
155+
.pytype/
156+
157+
# Cython debug symbols
158+
cython_debug/
159+
160+
# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
161+
162+
# PyCharm project settings
163+
.idea/
164+
.idea/workspace.xml
165+
.idea/ftcdocs.iml
166+
.idea/misc.xml
167+
.idea/misc.xml
168+
.idea/workspace.xml
169+
.idea/ftcdocs.iml

0 commit comments

Comments
 (0)