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

Update readthedocs, wiki, and READMEs #111

Open
1 of 6 tasks
sdhutchins opened this issue Oct 20, 2017 · 8 comments
Open
1 of 6 tasks

Update readthedocs, wiki, and READMEs #111

sdhutchins opened this issue Oct 20, 2017 · 8 comments

Comments

@sdhutchins
Copy link
Member

sdhutchins commented Oct 20, 2017

We need to update the readthedocs and wiki with our current documentation (mainly the tutorial).

I'm considering changing the style of the readthedocs page.

As it stands, we are in a fairly stable place #36 #33 #66 and others have all given our project a well-defined shape and functionality.

We need to add documentation to the Classes and modules that we've created.

  • Mini Tutorial (Readme in OrthoEvol directory)
  • Main README file
  • Tools
  • Cookies (custom cookiecutter templates)
  • Manager
  • Orthologs
@sdhutchins sdhutchins added this to the Official project release milestone Oct 20, 2017
@grabear
Copy link
Member

grabear commented Oct 20, 2017

Can you link to a guide for that. I haven't ever done any of that. I know all of our docs are in the Docs folder, but thats about it..

@sdhutchins
Copy link
Member Author

There's more to it than this, but it may take me a while to document what I did.

@sdhutchins
Copy link
Member Author

I'll take this on for this evening or in the morning.

@sdhutchins
Copy link
Member Author

@grabear http://datasnakes-scripts.readthedocs.io/en/docs-patch/index.html Those are the docs using the docs-path.

Much improved from http://datasnakes-scripts.readthedocs.io/en/master/

I'm still working on how to link to .rst files from within .rst files.

@sdhutchins
Copy link
Member Author

#123

@sdhutchins
Copy link
Member Author

Going to use https://github.com/kennethreitz/python-guide/tree/master/docs as a reference.

@sdhutchins
Copy link
Member Author

Still issues generating sphinx api docs, but docs are updated via #132

@sdhutchins sdhutchins changed the title Update readthedocs and wiki Update readthedocs, wiki, and READMEs Mar 25, 2018
@sdhutchins sdhutchins mentioned this issue Mar 25, 2018
10 tasks
@sdhutchins sdhutchins moved this from In Progress to To Do in Official Release Aug 28, 2018
@sdhutchins
Copy link
Member Author

  • Remove all Tools documentation from package

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants