sympy / sympy_doc Goto Github PK

SymPy Documentation repository

License: Other

CSS 0.10% JavaScript 0.12% Python 0.16% HTML 99.62%

sympy_doc's Introduction

SymPy Docs Repository

NOTE: The contents of this repository are generated automatically. To make modifications to the SymPy documentation, edit the RST sources in the doc directory of the main SymPy repo. Pull requests should only be made to this repo if you are modifying old version builds of the docs, or for emergency hotfixes.

This git repository contains all the generated SymPy documentation. It is hosted at http://docs.sympy.org/ automatically by github.

To build the docs in SymPy, cd into the SymPy clone, and do

cd doc
make clean
make html

Then the built docs are in _build/html. To update the docs here, there are several things.

Development docs

NOTE: The doctr command that runs on Travis on the sympy/sympy repo does this automatically. There is usually not a need to do this manually.

Build the docs from the latest SymPy master. Then, do

rm -rf dev/
cp -R ../path/to/sympy/doc/_build/html dev/

Then

git add -A dev/

Finally, you need to make sure the index of the different docs on the left of index.html remains intact. Run

./generate_indexes.py

Release docs

NOTE: This should be done automatically by the SymPy release script. It should only be done manually if the release script doesn't do it correctly for some reason.

First, completely remove the old release docs

git rm -rf latest/

Checkout the SymPy release tag and build the docs as above. Then do a cp -R ../path/to/sympy/doc/_build/html latest/

Then run

./generate_indexes.py

And add the results

git add -A dev/ latest/ releases.txt

Making redirects

The generate_redirects.py script can generate redirects from one path to another.

We used to host old versions of the docs on this, but now we only host the latest and development docs. The old docs that were there have redirects to the latest docs. This is only done so that old links can continue to work. It is not necessary to add redirects for future versions.

Pull requests

If you are making a significant change to the documentation in a pull request, feel free to use this site to upload a live version of it. Just create a directory with a reasonable name and put your docs there. If you share the link with a lot of people before the pull request is merged, you might want to sue the generate_redirects.py script to convert the special directory into a redirect to dev once the pull request is merged.

Pushing

Just push the branch up to GitHub. The pages will be updated automatically. If you don't have push access, fork this repo and make a pull request.

Automation

If you want to write a script to automate some or all of this process, that would be great. Just send a pull request. The script should probably go in the SymPy repo, as part of the build script for the release process.

sympy_doc's People

Contributors

Stargazers

Watchers

sympy_doc's Issues

New faster GitHub pages

I keep getting a warning mail from GH stating this:

The page build completed successfully, but returned the following warning:

GitHub Pages recently underwent some improvements (https://github.com/blog/1715-faster-more-awesome-github-pages) to make your site faster and more awesome, but we've noticed that docs.sympy.org isn't properly configured to take advantage of these new features. While your site will continue to work just fine, updating your domain's configuration offers some additional speed and performance benefits. Instructions on updating your site's IP address can be found at https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages, and of course, you can always get in touch with a human at [email protected]. For the more technical minded folks who want to skip the help docs: your site's DNS records are pointed to a deprecated IP address.

For information on troubleshooting Jekyll see:

  https://help.github.com/articles/using-jekyll-with-pages#troubleshooting

If you have any questions please contact us at https://github.com/contact.

@asmeurer is it possible to make these changes in DNS server? It says that it'll speed up the website.

Combination of $$ and bmatrix does not work?

It seems like bmatrix does not work when combined with $$. I have no understanding of why, but $$ works and bmatrix works when combined with .. math::.

The problem shows as (linsolve):

(I'm working on a new PR for SymPy where I have replaced bmatrix with array here, so it may go away if it is merged.)

Quicktip sidebar doesn't correctly pass code to live.sympy.org

http://docs.sympy.org/latest/tutorial/gotchas.html has a QuickTip sidebar.

The link "Run Code block in SymPy Live" within the sidebar, opens up the SymPy Live sub window, but does not pass the code from within the QuickTip to SymPy Live. The code in the Live sub window is the default for the page, not including the quicktip.

nC doc example in sympy live shows TypeError: 'Integer' object is not iterable

The first code block for nC shows an error:

Python console for SymPy 1.5.1 (Python 2.7.12)

These commands were executed:
>>> from __future__ import division
>>> from sympy import *
>>> x, y, z, t = symbols('x y z t')
>>> k, m, n = symbols('k m n', integer=True)
>>> f, g, h = symbols('f g h', cls=Function)

>>> from sympy.functions.combinatorial.numbers import nC
>>> from sympy.utilities.iterables import multiset_combinations
>>> nC(3, 2)
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/base/data/home/apps/s~sympy-live-hrd/66.426491309333028408/sympy/sympy/functions/combinatorial/numbers.py", line 1715, in nC
    return nC(_multiset_histogram(n), k, replacement)
  File "/base/data/home/apps/s~sympy-live-hrd/66.426491309333028408/sympy/sympy/functions/combinatorial/numbers.py", line 1435, in _multiset_histogram
    n = list(n)
TypeError: 'Integer' object is not iterable
>>> nC('abc', 2)
3

>>> nC('aab', 2)
2

Also the last code block errors too:

>>> sum(nC(4, i) for i in range(5))
Exception in SymPy Live of type 
<type 'exceptions.TypeError'>
for reference the last 5 stack trace entries are
Traceback (most recent call last):
  File "/base/data/home/apps/s~sympy-live-hrd/66.426491309333028408/app/handlers.py", line 271, in post
    live.evaluate(statement, session, printer, stream)
  File "/base/data/home/apps/s~sympy-live-hrd/66.426491309333028408/app/shell.py", line 280, in evaluate
    exec code in statement_module.__dict__
  File "<string>", line 1, in <module>
TypeError: 'NoneType' object is not iterable

links with method description

We should add links to the method code where the method is described.It makes life much easier.

sympy.org website is slow need to improve

sympy.org index.html file is very dirty.make common header,sphinxsidebarwrapper,footer,etc.
and put it in all sympy version index.html file.
Need to improve lots of thing see : PageSpeed Insights

Redirection loop in docs.sympy.org/latest

It looks like docs.sympy.org redirects to /latest, which redirects to /1.5.1, which redirects to latest again...

Tested on multiple browsers & devices

Problem with sympy live shell, in the right bottom of the pages

There is a problem with the live shell functionally which is in the right bottom of the documentation pages.
When I click once to open, it open up. When I click twice(tap, tap) then it get closed but when I click back to open then it does not open up.

Very long page load time

My clothes go out of style waiting for any page on https://docs.sympy.org/latest/ to load.

Chrome Network inspector notes the following did not load - ERR_CONNECTION_TIMED_OUT after 3.9 minutes:

Ubuntu 16.04
both Chrome 70.0.3538.77 and Firefox 63.0

Please fix! It's tricky to use the package without documentation :\

Rename generate_indexes.py to generate_indices.py

"Sympy 1.5.1" occurs twice in sympy docs

https://docs.sympy.org/1.5.1/index.html

Error in the example "A rolling disk using the Lagrange method"

The 3D case of the disk rolling on a plane is a non-holonomic problem (see https://en.wikipedia.org/wiki/Nonholonomic_system), to obtain the correct equations of motion within the Lagrangian formalism, the method of the indeterminate multipliers must be applied. For this, 5 coordinates must be used (for example, the XY coordinates of the contact point and the three Euler angles) and 2 multipliers corresponding to the two components of the speed of the disk at the contact point, which must be zero.
Although both kinetic and potential energy (in the documentation the potential has the wrong sign) can be calculated from the point of contact so that only the Euler angles appear, using these expressions for the Lagrangian does not obtain the equations of motion correct as these angles do not fully describe the position of the disc.
The correct solution of the equations of motion would be:
{q1 '': -2 * q2 '* q3' / cos (q2), q2 '': 4 * g * sin (q2) / (5 * r) + sin (2 * q2) * q1 '** 2 / 2 + 6 * cos (q2) * q1 '* q3' / 5, q3 '': - (10 * cos (q2) * q1 '- 12 * tan (q2) * q3') * q2 '/ 6}

Content needs to be formatted in

When we open index from footer tab, index opens up but text is not in the white area.

This needs to be fixed and i would love to work on it.

Error in SymPy tutorial - Gotchas

link: http://docs.sympy.org/latest/tutorial/gotchas.html

Eq(x + 1, 4)
x + 1 == 4

Actually the SymPy Live yields different value for the above part,
SymPy Live gives result to Eq(x + 1,4) as x+1=4 and not x + 1 == 4

First line of code blocks are not run on sympy live

Precision and accuracy are used interchangeably at many places.

Precision and accuracy are are two closely related terms but they do not mean the same.

What is generate_indexes.py needed for?

I'm looking at migrating from doctr/Travis to actions for updating the dev docs. I've also discussed this here: drdoctr/doctr#351 (comment)

It should be straight-forward to switch to Actions but it seems we need the generate_indexes.py script to run and that complicates using the available actions that can deploy to the docs. The script is currently run on Travis when updating the dev docs and also when updating the release docs as part of the release process. It seems to me that the obvious thing to do is to set up an action on this repo that runs generate_indexes.py each time a push is made here. That would simplify things at the other end because it means changes just need to be pushed and this repo will manage itself.

However when I look into the generate_indexes.py script I'm not clear what it's actually doing or if it is really needed.