-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1b78d52
commit 7a24fb5
Showing
5 changed files
with
97 additions
and
28 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
time to try something a bit different. up till now, this project has mostly been about code - at first cpp, then mixed cpp and py, and recently all three side by side in parallel - py, cpp, and mixed. that could evolve and grow now to encompass something wider. part of what's bringing this about is a better understanding that there's two tools in hand now - | ||
|
||
- sphinx - this is about python. with python, it's standard to do docstrings within the py code files. sphinx is simply a way to convert those into a static html website. | ||
- jekyll - this is effectively about github. with github, it's standard to do markdown files within the project. jekyll is simply a way to convert those into a static html website. | ||
|
||
project starid has been doing sphinx 'docsascode/readthedocs' for years. what's new is - experimenting with a jekyll 'project website' as well. so two separate websites flowing out of the project - 'docsascode/readthedocs' via sphinx, 'project website' via jekyll. |
Oops, something went wrong.