HackerRank (YC S11) DMCA’ed the SymPy Docs

8
[favorite_button]
HackerRank (YC S11) DMCA’ed the SymPy Docs
Advertisements

This is another beautiful !

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

Advertisements

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

Advertisements

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

Then

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

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.

Advertisements

First, completely remove the old release docs

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

And add the results

Advertisements

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.

Advertisements

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.

Read More
Share this on knowasiak.com to discuss with people on this topicSign Up on Knowasiak.com now if you’re not registered yet.

Advertisements
Charlie
WRITEN BY

Charlie

Fill your life with experiences so you always have a great story to tell
Get Connected!
One of the Biggest Social Platform for Entrepreneurs, College Students and all. Come and join our community. Expand your network and get to know new people!

Discussion(s)

No comments yet
Knowasiak We would like to show you notifications so you don't miss chats & status updates.
Dismiss
Allow Notifications