8000 Reorganize docs by skirpichev · Pull Request #582 · mpmath/mpmath · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Reorganize docs #582

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
Merged
merged 11 commits into from
Mar 27, 2021
Merged

Reorganize docs #582

merged 11 commits into from
Mar 27, 2021

Conversation

skirpichev
Copy link
Collaborator
  • doc/source/ -> docs/
  • *.txt -> *.rst
  • add missing references
  • fix some broken function references

On top of #578, I can rebase (depens on the review).

skirpichev added 11 commits March 27, 2021 01:13
@skirpichev
Drop redundant MANIFEST.in
f1b1e75
@skirpichev
Removed epydoc.conf
cee8392
@skirpichev
Removed pkgdocs.sh
baff800
@skirpichev
Drop TODO
bf9ea9f
@skirpichev
Add __pycache__/ to .gitignore
f4a5aec
@skirpichev
Cleanup sphinx config (drop useless and obsoleted options)
8b878f1
@skirpichev
Update copyright years
6aa2f3c
@skirpichev
Build docs on the GA CI
becbe0d
@skirpichev
Reorganize docs (doc/source/ -> docs/, *.txt -> *.rst)
a9550c2 
Structure now more closely follow https://packaging.python.org/

To build docs:

    python setup.py build_sphinx -c docs -b html,latex
    make -C build/sphinx/latex all-pdf
@skirpichev
Add missing references
4a2a320 
Note, that this changes sphinx docs for some constants.  Unfortunately,
there is no other way to display verbose docstrings for pi and euler.
@skirpichev
Fix ~250 broken references in sphinx docs
a5c95a8
@fredrik-johansson fredrik-johansson merged commit c11db84 into mpmath:master Mar 27, 2021
@skirpichev skirpichev deleted the doc-cleanup branch March 27, 2021 13:54
skirpichev added a commit to skirpichev/mpmath that referenced this pull request Mar 25, 2023
@skirpichev
Restore testing doctests/docs on CI (broken by mpmath#537)
91f3eef 
Corrects also pytest configuration after moving docs (mpmath#582)

Fixes mpmath#595
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@skirpichev @fredrik-johansson
0