Skip to content

Commit d5b7e1f

Browse files
Sphinx Init test
1 parent 3e1f7a2 commit d5b7e1f

3 files changed

Lines changed: 79 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Deploy Sphinx Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
24+
- name: Set up Python
25+
uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.10'
28+
29+
- name: Install dependencies
30+
run: |
31+
python -m pip install --upgrade pip
32+
pip install sphinx myst-parser sphinx-rtd-theme
33+
34+
- name: Build HTML documentation
35+
run: |
36+
sphinx-build -b html docs/ docs/_build/html
37+
38+
- name: Upload GitHub Pages artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: 'docs/_build/html'
42+
43+
deploy:
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
runs-on: ubuntu-latest
48+
needs: build
49+
steps:
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

docs/conf.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
project = 'PICA (Python Instrument Control and Automation)'
2+
copyright = '2026, Prathamesh Deshmukh'
3+
author = 'Prathamesh Deshmukh'
4+
5+
# Activate the MyST Parser to enable Markdown support alongside standard extensions
6+
extensions = [
7+
'myst_parser',
8+
'sphinx.ext.autodoc',
9+
]
10+
11+
# Instruct Sphinx to read both Markdown and reStructuredText formats
12+
source_suffix = {
13+
'.rst': 'restructuredtext',
14+
'.md': 'markdown',
15+
}
16+
17+
# Utilize the standard Read the Docs visual theme
18+
html_theme = 'sphinx_rtd_theme'

docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# PICA Documentation
2+
3+
Welcome to the documentation for the Python Instrument Control and Automation (PICA) software.
4+
5+
```{toctree}
6+
---
7+
maxdepth: 2
8+
---
9+
User_Manual.md

0 commit comments

Comments
 (0)