The xrst sphinx wrapper

39 views
Skip to first unread message

bradley...@gmail.com

unread,
Jan 1, 2023, 12:22:00 PM1/1/23
to sphinx-users
This is an announcement for the first stable release of xrst

This wrapper was motivated by cases like the GNU Scientific library, which is written in C, uses sphinx for its documentation, and has its documentation in separate files from the corresponding source code.

The following link lists the features that xrst adds to sphinx:
https://xrst.readthedocs.io/en/latest/purpose.html

The following is a list of problems and possible improvements:


bradley...@gmail.com

unread,
Jan 6, 2023, 7:52:12 AM1/6/23
to sphinx-users
I changed the name user_guide to user-guide (as a test) and there seems to be a problem with readthedocs.
The link
works fine and gets to the user-guide.html page, but the link
https://xrst.readthedocs.io/
tries to go to the old user_guide.html page (which is no longer there).

bradley...@gmail.com

unread,
Jan 6, 2023, 8:14:02 AM1/6/23
to sphinx-users
This is not a problem with readthedoc, it is a problem with how firefox handles redirects.

xrst is using a redirect in the index.html file to load any page that one chooses on the command line; e.g.,
```
<html><script> window.location.href="user-guide.html" </script></html>
```
The problem is that once firefox gets the redirect it never reloads it when it changes.
I had to clear my cache to get it to reload.
Reply all
Reply to author
Forward
0 new messages