Skip to content

MAINT: Sync with upstream changes #4

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

Merged
merged 1 commit into from
Apr 2, 2019

Conversation

bashtage
Copy link

@bashtage bashtage commented Apr 2, 2019

Pull in BasicRNG source changes from original author
Small doc fixes

Pull in BasicRNG source changes from original author
Small doc fixes
@bashtage
Copy link
Author

bashtage commented Apr 2, 2019

Should be the last one.

@mattip mattip merged commit c59585e into mattip:randomgen Apr 2, 2019
@mattip
Copy link
Owner

mattip commented Apr 2, 2019

@bashtage There are many documentation build warnings in bashtage/randomgen about the footnotes. Apparently they are never actually referenced.

@bashtage
Copy link
Author

bashtage commented Apr 2, 2019 via email

@mattip
Copy link
Owner

mattip commented Apr 2, 2019

See these warnings in bashtage/randomgen builds

@bashtage
Copy link
Author

bashtage commented Apr 2, 2019

Yes, I just ignore those. I assume that NumPy's doc system is happy to ignore these too (or doesn't create them in the first place), since there are many examples that are identical,

https://github.com/numpy/numpy/blob/master/numpy/random/mtrand/mtrand.pyx#L1797

@bashtage
Copy link
Author

bashtage commented Apr 2, 2019

It is possible numpydoc fixes these. I use napoleon in randomgen.

@mattip
Copy link
Owner

mattip commented Apr 3, 2019

Switching to numpydoc (in bashtage/randomgen) is worse: it now emits many warnings of the form

building [mo]: targets for 0 po files that are out of date
building [html]: targets for 198 source files that are out of date
updating environment: 198 added, 0 changed, 0 removed
reading sources... [100%] references                                                                                                          
docstring of randomgen.dsfmt.DSFMT:105: WARNING: toctree references unknown document 'brng/randomgen.dsfmt.DSFMT.jump'
docstring of randomgen.dsfmt.DSFMT:105: WARNING: toctree references unknown document 'brng/randomgen.dsfmt.DSFMT.random_raw'
docstring of randomgen.dsfmt.DSFMT:105: WARNING: toctree references unknown document 'brng/randomgen.dsfmt.DSFMT.seed'
...

This is the diff (requires pip install numpydoc)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index d4290d17..6fd7bcb5 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -43,8 +43,9 @@ release = randomgen.__version__
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.napoleon',
+    #'sphinx.ext.napoleon',
     'sphinx.ext.autodoc',
+    'numpydoc',
     'sphinx.ext.extlinks',
     'sphinx.ext.todo',
     'sphinx.ext.doctest',

@mattip
Copy link
Owner

mattip commented Apr 3, 2019

numpy/numpydoc#204

@bashtage
Copy link
Author

bashtage commented Apr 3, 2019

Seems to generate a ton of warnings but also works.

@mattip
Copy link
Owner

mattip commented Apr 3, 2019

I built both and diffed the html. Indeed the differences are only the docstring results.
Must be more of numpy/numpydoc#184. Now I need to find out why the :orphan: work around in doc/source/_templates/autosummary/*.rst in numpy is not preventing the warning.

@bashtage bashtage deleted the port-more-changes branch April 15, 2019 15:49
mattip pushed a commit that referenced this pull request Nov 19, 2021
commit 9c833bed5879d77e625556260690c349de18b433
Author: Thomas Li <[email protected]>
Date:   Wed Nov 17 16:21:27 2021 -0800

    Add Windows config to GHA

    update script [wheel build]

    typo [wheel build]

    fix typo? [wheel build]

    fix linux builds? [wheel build]

    typo [wheel build]

    add license and pin to windows 2016

    skip tests [wheel build]

    pin to windows 2019 instead [wheel build]

    try to find out the error on windows [wheel build]

    maybe fix? [wheel build]

    maybe fix? [wheel build]

    fix? [wheel build]

    cleanup [wheel build]

    Add Windows config to GHA

    update script [wheel build]

    typo [wheel build]

    fix typo? [wheel build]

    fix linux builds? [wheel build]

    typo [wheel build]

    add license and pin to windows 2016

    skip tests [wheel build]

    pin to windows 2019 instead [wheel build]

    try to find out the error on windows [wheel build]

    maybe fix? [wheel build]

    maybe fix? [wheel build]

    fix? [wheel build]

    cleanup [wheel build]

    Update LICENSE_win32.txt

    Update LICENSE_win32.txt

    Add Windows config to GHA

    update script [wheel build]

    typo [wheel build]

    fix typo? [wheel build]

    fix linux builds? [wheel build]

    typo [wheel build]

    add license and pin to windows 2016

    skip tests [wheel build]

    pin to windows 2019 instead [wheel build]

    try to find out the error on windows [wheel build]

    maybe fix? [wheel build]

    maybe fix? [wheel build]

    fix? [wheel build]

    cleanup [wheel build]

    Update LICENSE_win32.txt

    Update LICENSE_win32.txt

    Update cibw_test_command.sh

commit 4bd12df
Author: Thomas Li <[email protected]>
Date:   Mon Nov 15 17:28:47 2021 -0800

    # This is a combination of 14 commits.
    # This is the 1st commit message:

    Add Windows config to GHA
    # This is the commit message #2:

    update script [wheel build]
    # This is the commit message #3:

    typo [wheel build]
    # This is the commit message #4:

    fix typo? [wheel build]
    # This is the commit message #5:

    fix linux builds? [wheel build]
    # This is the commit message #6:

    typo [wheel build]
    # This is the commit message #7:

    add license and pin to windows 2016
    # This is the commit message #8:

    skip tests [wheel build]
    # This is the commit message #9:

    pin to windows 2019 instead [wheel build]
    # This is the commit message #10:

    try to find out the error on windows [wheel build]
    # This is the commit message #11:

    maybe fix? [wheel build]
    # This is the commit message #12:

    maybe fix? [wheel build]
    # This is the commit message #13:

    fix? [wheel build]
    # This is the commit message #14:

    cleanup [wheel build]
mattip pushed a commit that referenced this pull request Nov 15, 2023
…n that is not needed by the game of life example

Merge ss/hpy-scalar-types to labs-hpy-port

* commit '7ff906885dd929a6f33443aaad81ada3fed61f1e':
  Convert scalar types, comment out some initialization that is not needed by the game of life example
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.

2 participants