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

Improving Docs (2nd Try) #33

Closed
wants to merge 23 commits into from
Closed

Improving Docs (2nd Try) #33

wants to merge 23 commits into from

Conversation

sejal27
Copy link
Contributor

@sejal27 sejal27 commented Feb 1, 2019

  1. Merged all the content from GitHub ReadMe (markdown) with Sphinx-based (reStructuredText) docs on Read the Docs project. This provides a central space for all the documentation I have not removed GitHub Readme content yet.
  2. Provided a proper structure to the docs to enable smooth navigation.
  3. Converted the GitHub-markdown to Sphinx-reStructuredText.
  4. Added hyperlinks and a few linguistic changes.
  5. Committed some linguistic changes.
  6. Modified questions in the FAQ section to make them crisp.
  7. Added a section for doc contributions.
  8. Enabled hosting docs from GitHub Repo itself.

Read The Docs project: https://salesforcepy-sejal.readthedocs.io/en/latest/index.html
Github Pages: https://sejal27.github.io/SalesforcePy/

@sejal27
Copy link
Contributor Author

sejal27 commented Feb 1, 2019

Hello Aaron

This is my second try of adding the pull request where I am getting Travis CI build failure. I backed out all the annotation/docstring fixes in all .py files to be sure I didn't mess anything up. But the build still fails with the same error. I am guessing this is due to some other change and not mine. Could you please look into this when you find the time? Thanks.

@caffalaughrey
Copy link
Collaborator

The test pages site looks great! Invaluable contributions. Happy to work with you getting the documentation looking this way.

We should do this without storing everything in docs/_build. Do you reckon you could manage that? The advantage I've found with readthedocs so far is that the build can be triggered and it will run the sphinx commands and produce all the html for us. This makes it so when we're reviewing documentation PR's, there's an absolute minimum of boilerplate to get through.

Can you break your PR to forcedotcom:developer up into smaller change sets? This will help us give your work the attention it deserves, and it will likely make any issues with the build easier to investigate.

@caffalaughrey
Copy link
Collaborator

Closing this for now. Will be back again for the new PR with slimmed down changes.

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.

None yet

2 participants