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

Create separate documentation using Sphinx #89

Closed
Cito opened this issue May 17, 2020 · 1 comment
Closed

Create separate documentation using Sphinx #89

Cito opened this issue May 17, 2020 · 1 comment
Assignees
Labels
type: documentation An issue or pull request for improving or updating the documentation
Milestone

Comments

@Cito
Copy link
Member

Cito commented May 17, 2020

We should create separate documentation using Sphinx, since the README is getting too large.

The documentation can then be made availabel online as GitHub pages deployed with an GitHub action, or via ReadTheDocs. RTD has the advantage that it can create versioned docs if we need that.

@Cito Cito added the type: documentation An issue or pull request for improving or updating the documentation label May 17, 2020
@Cito Cito added this to the Version 3.0 milestone May 17, 2020
@captaincoordinates
Copy link

Versioned docs would be a major benefit because "the following documentation describes the current version which is currently only available as a pre-rel[e]ase". I don't want to risk using the alpha version in my application and I wasted time trying to understand why I could not import from gql.transport.aiohttp (it didn't exist in v2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating the documentation
Projects
None yet
Development

No branches or pull requests

4 participants