Skip to content

Sphinx docs #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chashton404 wants to merge 24 commits into
base: main
Choose a base branch
from
Open

Sphinx docs #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ea3ffbe
created the conf.py
chashton404 Apr 23, 2026
eb037b7
changed a comment
chashton404 Apr 26, 2026
42f675c
Added the sphinx-docs to the gitignore
chashton404 Apr 29, 2026
6bf82f7
added sphinx-docs to the Makefile
chashton404 Apr 29, 2026
1920b50
Added sphinx-docs to the tox file
chashton404 Apr 29, 2026
552a037
Moved conf.py to proper location
chashton404 Apr 29, 2026
74ee7c9
created the index landing page
chashton404 Apr 29, 2026
1764ff3
added svgs to sphinx_docs
chashton404 Apr 29, 2026
926b55a
added other md files to the opinf folder
chashton404 Apr 29, 2026
727b80e
Documentation updates
chashton404 Apr 29, 2026
b1f2b1a
Added pandas to deps with tox.ini
chashton404 Apr 29, 2026
f96dcb1
Created the Developer Guide Pages
chashton404 Apr 29, 2026
a359931
Implemented basics tutorial
chashton404 Apr 29, 2026
2a3e164
Created .md files for inputs and parametric tutorials
chashton404 Apr 30, 2026
52921b9
basis and opinf main done for API docs
chashton404 Apr 30, 2026
d8e3363
Added the markdown files for API folder
chashton404 Apr 30, 2026
f2b8234
Implemented references page
chashton404 Apr 30, 2026
9761cf2
Fixed error by removing the path_to_book and homepage_in_navbar
chashton404 Apr 30, 2026
823bea6
added templates for API documentation auto-generation.
chashton404 Apr 30, 2026
454cff3
Changed .ipynb references to .md
chashton404 Apr 30, 2026
0e89c42
added sphinx literature tox command
chashton404 Apr 30, 2026
7601f63
added python script to sphinx doc as well
chashton404 Apr 30, 2026
89e6376
Created a rough draft for new writing documentation page
chashton404 Apr 30, 2026
9a6722b
Fixed documentation page
chashton404 Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ docs/_build/
_autosummaries/
docs/source/opinf/literature.md

# Sphinx built documentation
sphinx-docs/build

# Extra Python files
*.py[cod]
__pycache__/
Expand Down
5 changes: 4 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: help clean_docs install dev format style test docs deploy_package deploy_docs
.PHONY: help clean_docs install dev format style test docs deploy_package deploy_docs sphinx_docs


REMOVE = rm -rfv
Expand Down Expand Up @@ -54,6 +54,9 @@ test: style
docs:
$(TOX) -e literature,docs

sphinx_docs:
$(TOX) -e sphinx-docs

all: test docs


Expand Down
Loading
Loading