Skip to content
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.

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

Add sphinx documentation instead of readmes #75

Merged
merged 12 commits into from
Dec 16, 2024
Merged

Add sphinx documentation instead of readmes #75

merged 12 commits into from
Dec 16, 2024

Conversation

malihass
Copy link
Collaborator

  • Reduce the size of README.md to the bare minimum (instruction for installation and references)
  • Add a docs folder with the rest of the documentation
  • Deploy documentation with GitHub pages (https://nrel.github.io/BioReactorDesign)
  • Add the machinery for automatic deployment

@malihass malihass requested review from hsitaram and fmuni December 16, 2024 02:42
@malihass malihass changed the title Add a proper documentation Add sphinx documentation instead of readmes Dec 16, 2024
Copy link
Collaborator

@fmuni fmuni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pages look great

@fmuni fmuni merged commit 90de193 into main Dec 16, 2024
10 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 16, 2024
Add sphinx documentation instead of readmes
@malihass malihass deleted the sphinx branch December 16, 2024 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants