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

Add sphinx documentation #126

Closed
wants to merge 3 commits into from
Closed

Conversation

raphapassini
Copy link

Hello dear reviewer,

I basically did three things:

  • Add the sphinx to the requirements-development.txt
  • Create a basic documentation, based on the Readme, with few improvements i've made.
  • Move some basic project information (intro and archtecture) to the init.py of the rows module

I think the Sphinx doc can also be used as a website, and maybe can be hosted at github pages.

[]'s
I hope this will be usefull! :)

@turicas
Copy link
Owner

turicas commented Oct 14, 2015

@raphapassini, thanks! :) I'm going to have a look in all changes during this week.

@turicas turicas self-assigned this Oct 19, 2015
@raphapassini
Copy link
Author

Hi @turicas, it's been a time since i've opened this request, any feedbacks? Thx.

@turicas
Copy link
Owner

turicas commented Nov 6, 2015

@raphapassini, sorry for the delay! Let's go:

  • The commits 45d7636 and 1ca8cd9 are ok;
  • The commit c424ace put a lot of static/binary files into the main branch and it's not the desired behaviour. I can create another branch (based on yours) and take only the files on rows-doc/source, since the source of the docs will be inside the main branch, but the "compiled" docs/site needs to sit on gh-pages branch (see more details on GitHub Pages docs).

I think the best approach would be:

  • Create a brand-new branch off of the current develop
  • Cherry-pick the commits 45d7636 and 1ca8cd9
  • Follow the instructions on continuous-docs
  • Checkout to commit c424ace and copy to another folder only the doc sources
  • Checkout again to the new branch and put the sources in there and commit

Can you please do these changes? We can do it together at PythonBrasil if you prefer! 👍

Thanks again for your collaboration!

@turicas
Copy link
Owner

turicas commented Nov 6, 2015

This PR is related to #43.

@turicas
Copy link
Owner

turicas commented May 8, 2017

Closing this issue since Sphinx was added on another PR.

@turicas turicas closed this May 8, 2017
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.

None yet

2 participants