sagemath/sage

Make Sage documentation functional

kwankyu opened this issue · 129 comments

Sage documentation (website) is currently buggy in many ways.

I tried to fix various defects I noticed, including

  • links in navigation bar
  • index page, which is now in single column
  • sage logo link always goes to the sagemath homepage
  • class names now look ragged right
  • long Bases for classes now horizontally scrolled
  • updated sage theme based on the latest classic theme of Sphinx
  • renamed sage theme to sage-classic theme (in anticipation of alternative themes)
  • remove unnecessary sageref theme; only use sage theme
  • remove obsolete python2.inv hyperlinks database
  • added a new index.html which is installed right into the root directory SAGE_DOC.
  • adjusted colors to increase contrast among elements
  • documentation access from jupyter notebook (this undoes #33206)
  • search box works (turned off Thebe)

As noted in the last item above, I turned off Thebe here. Work on reviving Thebe will continue in #33320 (perhaps very slowly).

To cleanly build the new documentation, try

$ make doc-uninstall && make doc-html && make doc-pdf

CC: @strogdon @haraldschilly @mkoeppe

Component: documentation

Author: Kwankyu Lee

Branch: acecf84

Reviewer: Tobias Diez, John Palmieri, François Bissey, Steven Trogdon

Issue created by migration from https://trac.sagemath.org/ticket/33309

Commit: 3b9e89f

New commits:

3b9e89fVarious fixes for sage documentation

Author: Kwankyu Lee

Description changed:

--- 
+++ 
@@ -1 +1,9 @@
+Sage documentation (website) is buggy in many ways.
 
+I tried to fix various defects I noticed, including
+
+- links in navigation bar, index, etc.
+
+- access from jupyter notebook
+
+- remove unnecessary `sageref` theme; only use `sage` theme

Description changed:

--- 
+++ 
@@ -2,7 +2,9 @@
 
 I tried to fix various defects I noticed, including
 
-- links in navigation bar, index, etc.
+- links in navigation bar
+
+- index page, which now in single column
 
 - access from jupyter notebook
 

Description changed:

--- 
+++ 
@@ -6,6 +6,6 @@
 
 - index page, which now in single column
 
-- access from jupyter notebook
+- documentation access from jupyter notebook (this undoes #33206)
 
 - remove unnecessary `sageref` theme; only use `sage` theme

Description changed:

--- 
+++ 
@@ -8,4 +8,6 @@
 
 - documentation access from jupyter notebook (this undoes #33206)
 
+Try `make doc-uninstall; make doc-html; make doc-pdf` to cleanly build the new documentation.
+
 - remove unnecessary `sageref` theme; only use `sage` theme

Description changed:

--- 
+++ 
@@ -8,6 +8,6 @@
 
 - documentation access from jupyter notebook (this undoes #33206)
 
+- remove unnecessary `sageref` theme; only use `sage` theme
+
 Try `make doc-uninstall; make doc-html; make doc-pdf` to cleanly build the new documentation.
-
-- remove unnecessary `sageref` theme; only use `sage` theme

Description changed:

--- 
+++ 
@@ -1,4 +1,4 @@
-Sage documentation (website) is buggy in many ways.
+Sage documentation (website) is currently buggy in many ways.
 
 I tried to fix various defects I noticed, including
 

Branch pushed to git repo; I updated commit sha1. New commits:

241ad3bMove pdf.png to the sage theme static directory

Changed commit from 3b9e89f to 241ad3b

Description changed:

--- 
+++ 
@@ -4,7 +4,7 @@
 
 - links in navigation bar
 
-- index page, which now in single column
+- index page, which is now in single column
 
 - documentation access from jupyter notebook (this undoes #33206)
 

Description changed:

--- 
+++ 
@@ -8,6 +8,8 @@
 
 - documentation access from jupyter notebook (this undoes #33206)
 
+- updated `sage theme based on the latest `basic` theme of Sphinx
+
 - remove unnecessary `sageref` theme; only use `sage` theme
 
 Try `make doc-uninstall; make doc-html; make doc-pdf` to cleanly build the new documentation.

Description changed:

--- 
+++ 
@@ -8,7 +8,7 @@
 
 - documentation access from jupyter notebook (this undoes #33206)
 
-- updated `sage theme based on the latest `basic` theme of Sphinx
+- updated `sage` theme based on the latest `basic` theme of Sphinx
 
 - remove unnecessary `sageref` theme; only use `sage` theme
 

Description changed:

--- 
+++ 
@@ -6,10 +6,12 @@
 
 - index page, which is now in single column
 
-- documentation access from jupyter notebook (this undoes #33206)
+- sage logo link always goes to the sagemath homepage
 
 - updated `sage` theme based on the latest `basic` theme of Sphinx
 
 - remove unnecessary `sageref` theme; only use `sage` theme
 
+- documentation access from jupyter notebook (this undoes #33206)
+
 Try `make doc-uninstall; make doc-html; make doc-pdf` to cleanly build the new documentation.

Description changed:

--- 
+++ 
@@ -8,6 +8,10 @@
 
 - sage logo link always goes to the sagemath homepage
 
+- `class` names now look ragged right
+
+- long `Bases` for classes now horizontally scrolled 
+
 - updated `sage` theme based on the latest `basic` theme of Sphinx
 
 - remove unnecessary `sageref` theme; only use `sage` theme

Branch pushed to git repo; I updated commit sha1. New commits:

348fecbFix a bug in reference pdf page

Changed commit from 241ad3b to 348fecb

Branch pushed to git repo; I updated commit sha1. New commits:

9030068make doc-pdf rebuilds website with pdf links

Changed commit from 348fecb to 9030068

comment:18

I'm really happy to see these improvements to the documentation. What do you think about replacing sage's own theme (based on the basic theme) by something modern like furo (probably not as part of this ticket but as a follow-up)?

comment:19

Typo in src/doc/common/themes/sage/static/sage.css_t:

-/* this is nice, but it leads to hidden headings when jumping
+/* this is nice, but it it leads to hidden headings when jumping
comment:20

With OS X, the top page of the reference manual displays math correctly, but a page like https://doc.sagemath.org/html/en/reference/padics/index.html (rather, the local version) shows "(p)" throughout. This doesn't seem to be a new problem. Any ideas for a fix?

Branch pushed to git repo; I updated commit sha1. New commits:

e9a24e1Fixes in headings and for a typo

Changed commit from 9030068 to e9a24e1

comment:22

Replying to @jhpalmieri:

Typo in src/doc/common/themes/sage/static/sage.css_t:

-/* this is nice, but it leads to hidden headings when jumping
+/* this is nice, but it it leads to hidden headings when jumping

This is a typo in the original basic.css_t file. Anyway, fixed here.

comment:23

Replying to @tobiasdiez:

I'm really happy to see these improvements to the documentation. What do you think about replacing sage's own theme (based on the basic theme) by something modern like furo (probably not as part of this ticket but as a follow-up)?

I agree that the sage theme looks old. But perhaps it has merits in that it is almost the basic theme officially provided by Sphinx.

Replacing the same theme with a theme not based on the basic theme would be a work on another level. Currently Sage doc build is entangled with the structure of the basic theme. So definitely it is not to be done here.

Eventually it would be good that we could choose at build time among alternative themes.

comment:24

Replying to @jhpalmieri:

With OS X, the top page of the reference manual displays math correctly, but a page like https://doc.sagemath.org/html/en/reference/padics/index.html (rather, the local version) shows "(p)" throughout. This doesn't seem to be a new problem. Any ideas for a fix?

This is because Sphinx does not see maths in the page and not include MathJax (to save loading time). My solution was to add :math:`.` somewhere in the page. It seem this has to be done for the afflicted pages individually. So this is not to be done here.

Branch pushed to git repo; I updated commit sha1. New commits:

3b3901bRemove obsolete python2.inv

Changed commit from e9a24e1 to 3b3901b

Changed commit from 3b3901b to b4f1a9b

Branch pushed to git repo; I updated commit sha1. New commits:

b4f1a9bEdit update-python-inv.sh

Description changed:

--- 
+++ 
@@ -16,6 +16,8 @@
 
 - remove unnecessary `sageref` theme; only use `sage` theme
 
+- remove obsolete `python2.inv` hyperlinks database
+
 - documentation access from jupyter notebook (this undoes #33206)
 
 Try `make doc-uninstall; make doc-html; make doc-pdf` to cleanly build the new documentation.
comment:28

Replying to @tobiasdiez:

What do you think about replacing sage's own theme (based on the basic theme) by something modern like furo (probably not as part of this ticket but as a follow-up)?

In anticipation of an alternative theme (perhaps based on furo) that may replace or live side by side with the current sage theme, we can rename the sage theme to sage-classic theme (since it is customized from the classic theme) in this ticket. Then later we may add sage-furo theme in another ticket. Okay?

comment:29

Sounds like a good idea!

Branch pushed to git repo; I updated commit sha1. New commits:

57a14caRename sage theme to sage-classic theme

Changed commit from b4f1a9b to 57a14ca

Description changed:

--- 
+++ 
@@ -12,7 +12,9 @@
 
 - long `Bases` for classes now horizontally scrolled 
 
-- updated `sage` theme based on the latest `basic` theme of Sphinx
+- updated `sage` theme based on the latest `classic` theme of Sphinx
+
+- renamed `sage` theme to `sage-classic` theme (in anticipation of alternative themes)
 
 - remove unnecessary `sageref` theme; only use `sage` theme
 
slel commented

Description changed:

--- 
+++ 
@@ -3,23 +3,18 @@
 I tried to fix various defects I noticed, including
 
 - links in navigation bar
-
 - index page, which is now in single column
-
 - sage logo link always goes to the sagemath homepage
-
 - `class` names now look ragged right
-
 - long `Bases` for classes now horizontally scrolled 
-
 - updated `sage` theme based on the latest `classic` theme of Sphinx
-
 - renamed `sage` theme to `sage-classic` theme (in anticipation of alternative themes)
-
 - remove unnecessary `sageref` theme; only use `sage` theme
-
 - remove obsolete `python2.inv` hyperlinks database
-
 - documentation access from jupyter notebook (this undoes #33206)
 
-Try `make doc-uninstall; make doc-html; make doc-pdf` to cleanly build the new documentation.
+To cleanly build the new documentation, try
+
+```
+$ make doc-uninstall && make doc-html && make doc-pdf
+```
comment:33

Codewise this looks good to me. I've also browsed around and couldn't find any issues. However, some of the pages don't work for me since on WSL the symlinks are not resolved by a Windows browser (this is also the case in the develop branch). So it's good if someone else double checks.

Reviewer: Tobias Diez, ...

comment:34

remove obsolete python2.inv hyperlinks database

Probably on another ticket, we should also fix src/doc/common/update-python-inv.sh to not use Python 2 anymore.

documentation access from jupyter notebook (this undoes #33206)

I'm confused by this: can you add more detail? (Did you solve the problem at #33206 in a different way, because the PDF links seem to work from the Jupyter notebook with this branch?)

comment:35

Replying to @jhpalmieri:

remove obsolete python2.inv hyperlinks database

Probably on another ticket, we should also fix src/doc/common/update-python-inv.sh to not use Python 2 anymore.

Or we can do it here if you want:

diff --git a/src/doc/common/update-python-inv.sh b/src/doc/common/update-python-inv.sh
index 537d6f4fb4..5c36cd378c 100755
--- a/src/doc/common/update-python-inv.sh
+++ b/src/doc/common/update-python-inv.sh
@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# The files python2.inv and python3.inv contain the database of Sphinx hyperlink targets
+# The file python3.inv contains the database of Sphinx hyperlink targets
 # used by the intersphinx extension. See
 #    http://sphinx-doc.org/ext/intersphinx.html
 # To be able to compile Sage without accessing the net, we use a local copy of
@@ -7,12 +7,10 @@
 
 if command -v wget > /dev/null 2>&1 ; then
     rm -f python.inv python2.inv python3.inv
-    wget https://docs.python.org/release/`sage --python2 --version 2>&1 | cut -d " " -f 2`/objects.inv -O - > python2.inv
     wget https://docs.python.org/release/`sage --python3 --version 2>&1 | cut -d " " -f 2`/objects.inv -O - > python3.inv
 elif command -v curl > /dev/null 2>&1 ; then
     # On OS X, curl is installed by default, but not wget.
     rm -f python.inv python2.inv python3.inv
-    curl https://docs.python.org/release/`sage --python2 --version 2>&1 | cut -d " " -f 2`/objects.inv > python2.inv
     curl https://docs.python.org/release/`sage --python3 --version 2>&1 | cut -d " " -f 2`/objects.inv > python3.inv
 else
     echo "Error: neither wget nor curl is installed."
comment:36

Or in fact you've already done it and I'm not paying attention, but I might keep rm -f python.inv python2.inv python3.inv in case people have old files lying around.

Branch pushed to git repo; I updated commit sha1. New commits:

29829cfKeep the rm line for people having old .inv files

Changed commit from 57a14ca to 29829cf

comment:38

Replying to @jhpalmieri:

... but I might keep rm -f python.inv python2.inv python3.inv in case people have old files lying around.

Right. Thanks.

comment:39

Replying to @jhpalmieri:

documentation access from jupyter notebook (this undoes #33206)

I'm confused by this: can you add more detail? (Did you solve the problem at #33206 in a different way, because the PDF links seem to work from the Jupyter notebook with this branch?)

I made this change

diff --git a/src/sage/repl/ipython_kernel/install.py b/src/sage/repl/ipython_kernel/install.py
index 2143c22..ab336e8 100644
--- a/src/sage/repl/ipython_kernel/install.py
+++ b/src/sage/repl/ipython_kernel/install.py
@@ -218,7 +218,7 @@ class SageKernelSpec(object):
                 os.path.join(self.kernel_dir, filename)
             )
         self.symlink(
-            os.path.join(SAGE_DOC, 'html', 'en'),
+            SAGE_DOC,
             os.path.join(self.kernel_dir, 'doc')
         )

which solves problems related with symlinks.

I am a little unsure if there could be security problems in exposing this much of path.

Branch pushed to git repo; I updated commit sha1. New commits:

177e67dMerge the code from #29576

Changed commit from 29829cf to 177e67d

Description changed:

--- 
+++ 
@@ -12,6 +12,7 @@
 - remove unnecessary `sageref` theme; only use `sage` theme
 - remove obsolete `python2.inv` hyperlinks database
 - documentation access from jupyter notebook (this undoes #33206)
+- search box works (turned off Thebe)
 
 To cleanly build the new documentation, try
 

New commits:

177e67dMerge the code from #29576

Description changed:

--- 
+++ 
@@ -14,6 +14,8 @@
 - documentation access from jupyter notebook (this undoes #33206)
 - search box works (turned off Thebe)
 
+As noted in the last item above, I turned off Thebe here. Work on reviving Thebe will (perhaps very slowly) continue in #33320.
+
 To cleanly build the new documentation, try
 
 ```

Description changed:

--- 
+++ 
@@ -14,7 +14,7 @@
 - documentation access from jupyter notebook (this undoes #33206)
 - search box works (turned off Thebe)
 
-As noted in the last item above, I turned off Thebe here. Work on reviving Thebe will (perhaps very slowly) continue in #33320.
+As noted in the last item above, I turned off Thebe here. Work on reviving Thebe will continue in #33320 (perhaps very slowly).
 
 To cleanly build the new documentation, try
 

Branch pushed to git repo; I updated commit sha1. New commits:

9ba5c62Styling search results and references

Changed commit from 177e67d to 9ba5c62

comment:45

Replying to @kwankyu:

Replying to @jhpalmieri:

documentation access from jupyter notebook (this undoes #33206)

I'm confused by this: can you add more detail? (Did you solve the problem at #33206 in a different way, because the PDF links seem to work from the Jupyter notebook with this branch?)

I made this change

diff --git a/src/sage/repl/ipython_kernel/install.py b/src/sage/repl/ipython_kernel/install.py
index 2143c22..ab336e8 100644
--- a/src/sage/repl/ipython_kernel/install.py
+++ b/src/sage/repl/ipython_kernel/install.py
@@ -218,7 +218,7 @@ class SageKernelSpec(object):
                 os.path.join(self.kernel_dir, filename)
             )
         self.symlink(
-            os.path.join(SAGE_DOC, 'html', 'en'),
+            SAGE_DOC,
             os.path.join(self.kernel_dir, 'doc')
         )

which solves problems related with symlinks.

I am a little unsure if there could be security problems in exposing this much of path.

Harald?

comment:46

It all looks good to me, so if we can settle the question about security and the path, I think we should merge it.

comment:47

If I am not mistaken you are just moving the root of the webserver to the directory SAGE_DOC. In a distro that would be a sage specific folder, so it doesn't expose anything other than sage objects. It doesn't bleed to other stuff. I am not sure what other security issue you would have.

The inconvenient bit is that now the kernel points to a folder without an index.html file I think.

comment:48

Replying to @kiwifb:

If I am not mistaken you are just moving the root of the webserver to the directory SAGE_DOC. In a distro that would be a sage specific folder, so it doesn't expose anything other than sage objects. It doesn't bleed to other stuff. I am not sure what other security issue you would have.

I agree. Okay then.

The inconvenient bit is that now the kernel points to a folder without an index.html file I think.

Would it be convenient to have a small index page at the root? The index page may contain the page listing all sage documentation, like

https://doc.sagemath.org/index.html

Really, we may use the source file of that page. Where is it?

Branch pushed to git repo; I updated commit sha1. New commits:

e456f2aAdd root index html page

Changed commit from 9ba5c62 to e456f2a

comment:50

Replying to @kwankyu:

Replying to @kiwifb:

The inconvenient bit is that now the kernel points to a folder without an index.html file I think.

Would it be convenient to have a small index page at the root? The index page may contain the page listing all sage documentation, like

https://doc.sagemath.org/index.html

Really, we may use the source file of that page. Where is it?

I created the root index.html file based on the source file of https://doc.sagemath.org/index.html. But unlike the original, our root index.html file is a simple static html file edited by hand.

Description changed:

--- 
+++ 
@@ -11,6 +11,7 @@
 - renamed `sage` theme to `sage-classic` theme (in anticipation of alternative themes)
 - remove unnecessary `sageref` theme; only use `sage` theme
 - remove obsolete `python2.inv` hyperlinks database
+- added a new `index.html` which is installed right into the root directory `SAGE_DOC`.
 - documentation access from jupyter notebook (this undoes #33206)
 - search box works (turned off Thebe)
 

Changed commit from e456f2a to 765bfd0

Branch pushed to git repo; I updated commit sha1. New commits:

765bfd0Adjust color styles to increase contrast

Description changed:

--- 
+++ 
@@ -12,6 +12,7 @@
 - remove unnecessary `sageref` theme; only use `sage` theme
 - remove obsolete `python2.inv` hyperlinks database
 - added a new `index.html` which is installed right into the root directory `SAGE_DOC`.
+- adjusted colors to increase contrast among elements
 - documentation access from jupyter notebook (this undoes #33206)
 - search box works (turned off Thebe)
 
comment:54

There will be no more commits, hopefully.

Ready for review.

Changed commit from 765bfd0 to 6f8d298

Branch pushed to git repo; I updated commit sha1. New commits:

6f8d298Edits on the website page
comment:56

Sorry. I could not overlook these typos.

comment:57

Is the new top-level index.html supposed to be accessible through Sage? Or through the other documentation web pages?

comment:58

Replying to @jhpalmieri:

Is the new top-level index.html supposed to be accessible through Sage?

I am negative in that. There would be little usage.

Or through the other documentation web pages?

(1) It may replace the index page now at https://doc.sagemath.org. This is up to Harald.

(2) We may add a link to the top-level index.html in html/en/index.html. I can do this in this ticket, if you want.

comment:59

Okay, I think it's fine to leave as is. Maybe the only advantage would be to provide easier access to non-English documentation, but that has not so far been a priority.

comment:60

Replying to @jhpalmieri:

Okay, I think it's fine to leave as is. Maybe the only advantage would be to provide easier access to non-English documentation, but that has not so far been a priority.

The fact that the reference manual only exists in English may have something to do with that.

comment:61

Replying to @jhpalmieri:

Okay, I think it's fine to leave as is. Maybe the only advantage would be to provide easier access to non-English documentation, but that has not so far been a priority.

I think it's good to have the following link. No?

diff --git a/src/doc/en/website/templates/index.html b/src/doc/en/website/templates/index.html
index 6444d0c09d..b04fd4861f 100644
--- a/src/doc/en/website/templates/index.html
+++ b/src/doc/en/website/templates/index.html
@@ -23,6 +23,7 @@
 
 {% block body %}
 <h1>{{ docstitle|e }}</h1>
+<p>This is documentation for Sage {{ release }}. Sage documentation in other languages is <a href="../../index.html">here</a>.
 {% block tables %}
 <h2>
   <strong>
comment:62

Replying to @jhpalmieri:

With OS X, the top page of the reference manual displays math correctly, but a page like https://doc.sagemath.org/html/en/reference/padics/index.html (rather, the local version) shows "(p)" throughout. This doesn't seem to be a new problem. Any ideas for a fix?

A relevant discussion is here: sphinx-doc/sphinx#10192

Changed commit from 6f8d298 to eda0a74

Branch pushed to git repo; I updated commit sha1. New commits:

326530dMerge branch 'develop'
eda0a74Add a link to documentations in other languages
comment:64

We could force the issue with this:

diff --git a/src/doc/en/reference/conf_sub.py b/src/doc/en/reference/conf_sub.py
index ccb7f0ccf10..6c377eddce3 100644
--- a/src/doc/en/reference/conf_sub.py
+++ b/src/doc/en/reference/conf_sub.py
@@ -22,6 +22,8 @@ from sage.docs.conf import *
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+html_js_files = ['MathJax.js?config=TeX-AMS_HTML-full', 'mathjax_sage.js']
+
 ref_src = os.path.join(SAGE_DOC_SRC, 'en', 'reference')
 ref_out = os.path.join(SAGE_DOC, 'html', 'en', 'reference')
 

New commits:

326530dMerge branch 'develop'
eda0a74Add a link to documentations in other languages
comment:65

Replying to @jhpalmieri:

We could force the issue with this:

diff --git a/src/doc/en/reference/conf_sub.py b/src/doc/en/reference/conf_sub.py
index ccb7f0ccf10..6c377eddce3 100644
--- a/src/doc/en/reference/conf_sub.py
+++ b/src/doc/en/reference/conf_sub.py
@@ -22,6 +22,8 @@ from sage.docs.conf import *
 # contains common paths.
 html_static_path = [] + html_common_static_path
 
+html_js_files = ['MathJax.js?config=TeX-AMS_HTML-full', 'mathjax_sage.js']
+
 ref_src = os.path.join(SAGE_DOC_SRC, 'en', 'reference')
 ref_out = os.path.join(SAGE_DOC, 'html', 'en', 'reference')
 

This solution has its own problem. See #33347.

comment:66

Replying to @kwankyu:

I think it's good to have the following link. No?

diff --git a/src/doc/en/website/templates/index.html b/src/doc/en/website/templates/index.html
index 6444d0c09d..b04fd4861f 100644
--- a/src/doc/en/website/templates/index.html
+++ b/src/doc/en/website/templates/index.html
@@ -23,6 +23,7 @@
 
 {% block body %}
 <h1>{{ docstitle|e }}</h1>
+<p>This is documentation for Sage {{ release }}. Sage documentation in other languages is <a href="../../index.html">here</a>.
 {% block tables %}
 <h2>
   <strong>

Here from the above created link all the html and pdf language links do not work, i.e. for example the English html link gives

doc/html/en is not a file
comment:67

Replying to @strogdon:

Here from the above created link all the html and pdf language links do not work, i.e. for example the English html link gives

doc/html/en is not a file

I don't understand. Did you build the doc using the latest commit? Or copy pasted from the above diff?

For me, for example, The "English" link lists files in html/en as it is supposed to do.

comment:68

Replying to @kwankyu:

Replying to @strogdon:

Here from the above created link all the html and pdf language links do not work, i.e. for example the English html link gives

doc/html/en is not a file

I don't understand. Did you build the doc using the latest commit? Or copy pasted from the above diff?

For me, for example, The "English" link lists files in html/en as it is supposed to do.

For a new branch git trac fetch 33309 and then git merge FETCH_HEAD. To build make doc-clean doc-uninstall and then make doc-pdf. I've done this before. html and pdf links look good except the above link. All links on the page seem to work except the language links. Is there something else necessary that I should do?

comment:69

For example the English link appears as

<div class="cell lang"><a href="html/en">English</a></div>

This works

<div class="cell lang"><a href="html/en/index.html">English</a></div>

I'm doing this from the notebook

comment:70

Replying to @strogdon:

For example the English link appears as

<div class="cell lang"><a href="html/en">English</a></div>

This works

<div class="cell lang"><a href="html/en/index.html">English</a></div>

I'm doing this from the notebook

What happens if you open html/en/? I suspect the tailing slash matters.

Branch pushed to git repo; I updated commit sha1. New commits:

de5ac65Add trailing slash to links to directories

Changed commit from eda0a74 to de5ac65

comment:72

You can save time by using sage -docbuild website html.

comment:73

Replying to @sagetrac-git:

Branch pushed to git repo; I updated commit sha1. New commits:

de5ac65 Add trailing slash to links to directories
This make no difference here from the notebook. For the French language I get
doc/html/fr/ is not a file

I'm not an expert on this but I think for this to work from the notebook there needs to be an index.html file under each language that contains links to docs for that language. Things work locally but not from the notebook.

comment:74

Replying to @strogdon:

Replying to @sagetrac-git:

Branch pushed to git repo; I updated commit sha1. New commits:

de5ac65 Add trailing slash to links to directories
This make no difference here from the notebook. For the French language I get
doc/html/fr/ is not a file

I'm not an expert on this but I think for this to work from the notebook there needs to be an index.html file under each language that contains links to docs for that language. Things work locally but not from the notebook.

Me neither. But I guess listing files for directory url is a fairly standard behaviour of a browser or a web server.

comment:75

Replying to @strogdon:

...Things work locally but not from the notebook.

You meant Jupyter notebook. Yes, I see what you see.

comment:76

Replying to @strogdon:

I think for this to work from the notebook there needs to be an index.html file under each language that contains links to docs for that language.

I agree, but I should leave this work to other experts in each language.

comment:77

Replying to @kwankyu:

Replying to @strogdon:

I think for this to work from the notebook there needs to be an index.html file under each language that contains links to docs for that language.

I agree, but I should leave this work to other experts in each language.

I didn't think about it at the time but one could keep the language names on the local/share/doc/sage/index.html page but remove there link capabilities. The language names do not need to be links since everything else appears on the index.html.

comment:78

Replying to @strogdon:

I didn't think about it at the time but one could keep the language names on the local/share/doc/sage/index.html page but remove there link capabilities. The language names do not need to be links since everything else appears on the index.html.

Okay. I agree.

Branch pushed to git repo; I updated commit sha1. New commits:

a53040bRemove links in languages

Changed commit from de5ac65 to a53040b

Changed commit from a53040b to 4bda258

Branch pushed to git repo; I updated commit sha1. New commits:

4bda258Fix font-size