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.

Sign up for GitHub

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

Jump to bottom

Migrate documentation to Documenter #103

Closed
ararslan opened this issue Aug 8, 2017 · 6 comments
Closed

Migrate documentation to Documenter #103

ararslan opened this issue Aug 8, 2017 · 6 comments
Labels
docs

Comments

@ararslan
Copy link
Member

ararslan commented Aug 8, 2017

The following things would need to happen as part of the migration:

  • Rename doc/ to docs/ (git mv doc docs)
  • Convert ReST files to Markdown
  • Move specific method and type documentation to docstrings
@ararslan ararslan added the docs label Aug 8, 2017
@ararslan ararslan mentioned this issue Aug 8, 2017
Closed
@BenjaminBorn
Copy link
Contributor

Would you prefer all of this in one big pull request or would it be ok to go step by step? If it's ok, I would start with a PR that moves specific method and type documentation to docstrings.

@ararslan
Copy link
Member Author

Sure, that'd be fantastic!

@BenjaminBorn BenjaminBorn mentioned this issue Aug 21, 2017
Merged
@BenjaminBorn
Copy link
Contributor

I also managed to build the new docs locally using Documenter with native HTML output. I'll send a PR once #106 is merged. If I understand it correctly (I'm a total Documenter noob), we need Travis and Github keys. @ararslan can you set them up for the repository?

@ararslan
Copy link
Member Author

Can do.

@ararslan
Copy link
Member Author

Keys added and gh-pages branch created.

@BenjaminBorn BenjaminBorn mentioned this issue Aug 28, 2017
Merged
@ararslan
Copy link
Member Author

This task has been valiantly completed by the intrepid @BenjaminBorn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ararslan @BenjaminBorn