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

Add Sphincs-based documentation #130

Merged
merged 73 commits into from
Mar 26, 2019
Merged

Add Sphincs-based documentation #130

merged 73 commits into from
Mar 26, 2019

Conversation

nbraud
Copy link
Collaborator

@nbraud nbraud commented Mar 23, 2019 •
edited
Loading

Closes #109

AstraLuma and others added 16 commits March 23, 2019 14:12
@AstraLuma
Run sphinx-quickstart
820dc4d
@nbraud
README: Miscellaneous improvements in API description
a866e64
@nbraud
Start moving API documentation from README to docstrings
c8ecf0c
@nbraud
README: Slight improvement
da86482
@nbraud
Vector2: Add a class docstring
0515851
@nbraud
Vector2.convert: Improve docstring
b8dd905
@AstraLuma
Use RTD theme
f24a6cb
@AstraLuma
Add docs requirements
7de90f5
@nbraud
docs: Generate docs for Vector2 using autoclass
cb0b0b6 
Also, remove the useless Table of Contents
@nbraud
Vector2: Remove installation instructions from the class docstring
131d34b
@nbraud
Vector2: Start converting docstrings to rst markup
9c78c0f
@AstraLuma
Add intersphinx to core python docs
54ecf23
@AstraLuma
Add sphinx_autodoc_annotation
c60537c
@AstraLuma
Merge pull request #128 from nbraud/pydoc
5cd676f 
Add the docstrings work to the Sphinx branch
@nbraud
docs: Add missing dependency on sphinx_rtd_theme
8856b7b
@nbraud
Vector2: Add markup for references in the docstrings
0e9b47f
@nbraud nbraud requested a review from pathunstrom March 23, 2019 19:44
AstraLuma and others added 11 commits March 23, 2019 16:07
@nbraud nbraud mentioned this pull request Mar 23, 2019
Merged
@nbraud
Copy link
Collaborator Author

nbraud commented Mar 24, 2019 •
edited
Loading

@astronouth7303 What do you think of d51a958 ?

@AstraLuma
Copy link
Member

Ehhh... I'm not sure it's less awkward, but it's less-complicated terms? idk.

@nbraud
Copy link
Collaborator Author

nbraud commented Mar 24, 2019

@astronouth7303 Part of the point is that not all methods return Vector, so I wanted to clarify that, but I also think it's still an awkward formulation. :(

@nbraud
Copy link
Collaborator Author

nbraud commented Mar 25, 2019

@pathunstrom Do you think you will have time to review this, or should @astronouth7303 and I go ahead and merge?

pathunstrom
pathunstrom reviewed Mar 25, 2019
View reviewed changes
docs/conf.py
author = 'Piper Thunstrom, Jamie Bliss'

# The short X.Y version
version = ''
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this autofilled?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not as far as I know? I'm also not sure where it's used.

pathunstrom
pathunstrom approved these changes Mar 25, 2019
View reviewed changes
Copy link
Collaborator

@pathunstrom pathunstrom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not happy with the output around the magic methods, but until we find a solution that is nicer, this is good enough.

@nbraud
Copy link
Collaborator Author

nbraud commented Mar 26, 2019

bors r=pathunstrom

bors bot added a commit that referenced this pull request Mar 26, 2019
@bors @AstraLuma @nbraud
Merge #130
b1c6247 
130: Add Sphincs-based documentation r=pathunstrom a=nbraud

Closes #109 

Co-authored-by: Jamie Bliss <jamie@ivyleav.es>
Co-authored-by: Nicolas Braud-Santoni <nicolas@braud-santoni.eu>
@nbraud
Copy link
Collaborator Author

nbraud commented Mar 26, 2019

@astronouth7303 Looks like Travis CI picked up on Bors' temporary branch, failed to clone them due to a race-condition (Bors deleted the temp branch before Travis could clone it), and marked the PR as failing as a result; do you think this is worth fixing?

@pathunstrom
Copy link
Collaborator

Didn't we try to keep Travis from running against the tmp branches?

@nbraud
Copy link
Collaborator Author

nbraud commented Mar 26, 2019

@pathunstrom Nope, I forgot about Travis in #135 ;_;

@bors
Copy link
Contributor

bors bot commented Mar 26, 2019

Build succeeded

  • docs
  • FreeBSD PYTHON:3.6
  • FreeBSD PYTHON:3.7
  • lint
  • Linux container:python:3.6-slim
  • Linux container:python:3.7-slim
  • macOS PYTHON:3.6.8
  • macOS PYTHON:3.7.2
  • Windows container:python:3.6-windowsservercore-1809
  • Windows container:python:3.7-windowsservercore-1809

@bors bors bot merged commit 7d56285 into master Mar 26, 2019
@nbraud nbraud deleted the sphinx branch March 26, 2019 15:02
@nbraud
Copy link
Collaborator Author

nbraud commented Mar 26, 2019

This took a while because the Windows tasks all timed out waiting to start (after 15 minutes) the first time around; I guess Cirrus is having issues with their Windows boxes?

@pathunstrom
Copy link
Collaborator

Better it wastes time on an unwatched server than one of our machines.

I think I like this bors process, even if I've not initiated it yet.

@nbraud
Copy link
Collaborator Author

nbraud commented Mar 27, 2019

Yes, I find it pretty convenient, since one can just tell it to merge and it will notify once CI is done on the merge commit, and push the merge (if CI is green), rather than having a human waiting on CI :)

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

@AstraLuma AstraLuma AstraLuma left review comments

@pathunstrom pathunstrom pathunstrom approved these changes

Assignees

@AstraLuma AstraLuma

@nbraud nbraud

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nbraud @AstraLuma @pathunstrom