-
-
Notifications
You must be signed in to change notification settings - Fork 1
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
initial sphinx #2
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll want to add a .gitignore file with the following:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did get this code to run (hurrah!) but we have some duplicate files and can rearrange some things. It looks like the Makefile's SOURCEDIR is building from donor-data-pipeline/docsrc/docsrc
. I think the build could be done from a single folder with a flat set of files.
My suggestion is that the folder structure looks like this:
donor-data-pipeline/
├── docsrc/
│ ├── Makefile
│ ├── README.md
│ ├── simple_test.rst
│ ├── conf.py
│ ├-── index.rst
│ └── make.bat
I made some comments/suggestions on files in both docsrc and docsrc/docsrc. Let me know if you have any questions!
docsrc/conf.py
Outdated
# | ||
import os | ||
import sys | ||
sys.path.insert(0, os.path.abspath('../../..')) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we keep all files at the same level within a single donor-data-pipeline/docsrc folder, then sys.path.insert(0, os.path.abspath("..")) should solve this as well.
initial sphinx