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

initial sphinx #2

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

initial sphinx #2

wants to merge 9 commits into from

Conversation

rpwils
Copy link

@rpwils rpwils commented Aug 24, 2019

initial sphinx

@rpwils rpwils requested review from ed-nykaza and jameno August 24, 2019 19:37
ed-nykaza
ed-nykaza previously approved these changes Aug 25, 2019
Copy link
Contributor

@ed-nykaza ed-nykaza left a comment

Choose a reason for hiding this comment

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

@rpwils I found a few typos, and was not able to run build clean. I am going to approve the pull request so we can keep moving forward, but I'm thinking that a walkthrough of how this works, might be worthwhile. (cc: @jameno)

docs/html/_static/documentation_options.js Show resolved Hide resolved
docsrc/README.md Outdated Show resolved Hide resolved
docsrc/README.md Outdated Show resolved Hide resolved
docsrc/README.md Outdated Show resolved Hide resolved
docsrc/README.md Outdated Show resolved Hide resolved
environment.yml Show resolved Hide resolved
environment.yml Outdated Show resolved Hide resolved
test_module/simple_test.py Outdated Show resolved Hide resolved
test_module/simple_test.py Outdated Show resolved Hide resolved
test_module/simple_test.py Outdated Show resolved Hide resolved
@jameno
Copy link
Contributor

jameno commented Aug 27, 2019

We'll want to add a .gitignore file with the following:

# Environments
.env
# General
.DS_Store
data
export
# Python
__pycache__

Copy link
Contributor

@jameno jameno left a 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/README.md Outdated Show resolved Hide resolved
docsrc/conf.py Outdated
#
import os
import sys
sys.path.insert(0, os.path.abspath('../../..'))
Copy link
Contributor

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.

docsrc/conf.py Outdated Show resolved Hide resolved
docsrc/conf.py Outdated Show resolved Hide resolved
docsrc/conf.py Outdated Show resolved Hide resolved
test_module/simple_test.py Outdated Show resolved Hide resolved
test_module/simple_test.py Outdated Show resolved Hide resolved
environment.yml Show resolved Hide resolved
docsrc/index.rst Outdated Show resolved Hide resolved
docsrc/docsrc/index.rst Outdated Show resolved Hide resolved
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.

3 participants