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

improve documentation in main loops #42

Merged
merged 4 commits into from
May 28, 2020
Merged

Conversation

amoodie
Copy link
Member

@amoodie amoodie commented May 27, 2020

some docs effort. Nothing important.

Copy link
Member

@elbeejay elbeejay left a comment

Choose a reason for hiding this comment

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

Few minor things but overall it is a pretty straightforward one.

Realized I need to look into my local sphinx setup as well as the stratigraphy stuff (#43, some of which you created a framework for documenting here)

docs/source/guides/userguide.rst Outdated Show resolved Hide resolved
docs/source/guides/userguide.rst Outdated Show resolved Hide resolved
pyDeltaRCM/deltaRCM_driver.py Show resolved Hide resolved
pyDeltaRCM/deltaRCM_driver.py Outdated Show resolved Hide resolved
@elbeejay
Copy link
Member

elbeejay commented May 28, 2020

I guess a follow-up note was that I re-built an environment to try to sort out the docs locally and still didn't get the full API documentation and method links. Checking the hosted documentation reveals that we have the same issue with the 'live' version (e.g. here). I don't have a clue as to why it isn't working (especially given that it appeared to be fine on your local version).

@amoodie
Copy link
Member Author

amoodie commented May 28, 2020

thanks for checking it out @elbeejay, and for catching that the builds on travis were JUNK! I've pinned the sphinx version to 2.0.1 (so you should downgrade your environment version) and I've opened an issue to remind myself to revisit this down the road.

@amoodie amoodie merged commit 8f0e45d into DeltaRCM:develop May 28, 2020
amoodie added a commit to amoodie/pyDeltaRCM that referenced this pull request Feb 25, 2021
improve documentation in main loops
@amoodie amoodie deleted the docs branch February 25, 2021 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants