Opened 3 years ago

Closed 3 years ago

Last modified 2 years ago

#30076 closed defect (fixed)

remove sagenb developer docs from the developer manual and tutorials, remove sws stuff

Reported by: Dima Pasechnik Owned by:
Priority: major Milestone: sage-9.2
Component: documentation Keywords:
Cc: Matthias Köppe, Michael Orlitzky, François Bissey, Karl-Dieter Crisman, ​slelievre, Reimundo Heluani Merged in:
Authors: Dima Pasechnik Reviewers: Matthias Koeppe, Reimundo Heluani, John Palmieri
Report Upstream: N/A Work issues: fix pt,ja files
Branch: cd42104 (Commits, GitHub, GitLab) Commit:
Dependencies: #30064, #21559 Stopgaps:

Status badges

Description (last modified by Dima Pasechnik)

https://doc.sagemath.org/html/en/developer/index.html#sage-notebook-developer-guide is still present, and should be removed, as we don't have sagenb any more.

Also, remove various sws2bla and bla2sws scripts and related docs

Change History (27)

comment:1 Changed 3 years ago by Dima Pasechnik

Authors: Dima Pasechnik
Cc: Matthias Köppe added

branch in the workshop

comment:2 Changed 3 years ago by Dima Pasechnik

Branch: u/dimpase/docs/nosagenbdocs
Cc: Michael Orlitzky François Bissey Karl-Dieter Crisman added
Commit: e719cb23da0f6bf92838eb2bd8bfa3126f31faa5
Dependencies: #30064
Status: newneeds_review

New commits:

539c182build/make/install: Do not depend on src/bin/sage-version.sh
761092cMerge branch 't/29987/build_make_install__do_not_depend_on_src_bin_sage_version_sh' into t/30064/fix_tox_docker_builds_broken_by__29884
f2efa6asrc/doc/bootstrap: Create the directory src/doc/en/reference/repl if it does not exist
b7bf43bbuild/bin/write-dockerfile.sh: ADD src/bin for bootstrapping, needed by src/doc/bootstrap after #29884
e719cb2remove sagenb docs

comment:3 Changed 3 years ago by git

Commit: e719cb23da0f6bf92838eb2bd8bfa3126f31faa5dcde9c8ead371f1e3bb5507f947c387437603fc8

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

dcde9c8more traces of sws

comment:4 Changed 3 years ago by John Palmieri

For the tutorial, I would suggest removing the section _section_notebook completely, and making a change like this:

  • src/doc/en/tutorial/introduction.rst

    diff --git a/src/doc/en/tutorial/introduction.rst b/src/doc/en/tutorial/introduction.rst
    index 10f929fc97..e52077c221 100644
    a b Ways to Use Sage 
    103103You can use Sage in several ways.
    104104
    105105
    106 -  **Notebook graphical interface:** see the section on the
    107    Notebook in the reference manual and :ref:`section-notebook` below,
     106-  **Notebook graphical interface:** run `sage -n jupyter`; see
     107   `the Jupyter documentation on-line <https://jupyter-notebook.readthedocs.io/en/latest/notebook.html>`_,
    108108
    109109-  **Interactive command line:** see :ref:`chapter-interactive_shell`,
    110110

Unfortunately I don't know to write that in the various languages we offer. If you don't want to do this, I would at least suggest removing "the section on the Notebook in the reference manual", since I don't think that such a section exists.

comment:5 Changed 3 years ago by Dima Pasechnik

there are still leftovers of sws format stuff in docs.

comment:6 Changed 3 years ago by git

Commit: dcde9c8ead371f1e3bb5507f947c387437603fc8a633ff39252f9e17bdf3aebbae1ad0e4f1733705

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

a6689e2rest of the traces of sws
a633ff3removed _section-notebook and rewrote

comment:7 Changed 3 years ago by Dima Pasechnik

Cc: ​slelievre added
Work issues: fix fr,pt,es, ja files, and src/mac-app/

OK, I think I managed en/ru/de[plattdeutsch:-)] and for fr/es/pt/jp I inserted a bit of English (pardon...).

Could someone versed enough in these please fix these languages.

The remaining challende is to fix Sage Mac app, which refers to sws files in menus etc. For this we need someone who knows enough Xcode IDE, I gather.

comment:8 Changed 3 years ago by git

Commit: a633ff39252f9e17bdf3aebbae1ad0e4f1733705a9ca087205be1db6db8a8d9cd527eb765f3c8442

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

a9ca087google-translated for es/fr/ja/pt

comment:9 Changed 3 years ago by Dima Pasechnik

Description: modified (diff)
Summary: remove sagenb developer docs from the developer manual.remove sagenb developer docs from the developer manual and tutorials, remove sws stuff

comment:10 Changed 3 years ago by Matthias Köppe

Removal of binaries is best done on top of #21559

Last edited 3 years ago by Matthias Köppe (previous) (diff)

comment:11 Changed 3 years ago by Matthias Köppe

sed -i.bak 's/aufrufen Sie `sage -n jupyter`/rufen Sie `sage -n jupyter` auf/' src/doc/de/tutorial/introduction.rst

comment:12 Changed 3 years ago by Dima Pasechnik

Dependencies: #30064#30064, #21559

comment:13 Changed 3 years ago by git

Commit: a9ca087205be1db6db8a8d9cd527eb765f3c844288dd95f9268022d0c959c4b660a3a2450c48b7b6

Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:

3ea1583src/doc/bootstrap: Create the directory src/doc/en/reference/repl if it does not exist
a3690fbbuild/bin/write-dockerfile.sh: ADD src/bin for bootstrapping, needed by src/doc/bootstrap after #29884
8d42d9aremove sagenb docs
836386cmore traces of sws
cc6924erest of the traces of sws
e116330removed _section-notebook and rewrote
d26869cgoogle-translated for es/fr/ja/pt
4ac0fafcomplete rebase by stripping last bits of sws
855d65ffix DE typo
88dd95fsmall fixes to the tutorial in spanish

comment:14 Changed 3 years ago by Dima Pasechnik

Cc: Reimundo Heluani added
Reviewers: Matthias Koeppe, Reimundo Heluani

Spanish done, thanks to Reimundo.

comment:15 Changed 3 years ago by David Coudert

This could be better for french in src/doc/fr/tutorial/introduction.rst

--  **Interface graphique (« notebook ») :** démarrer `sage -n jupyter`; lire 
-   `Jupyter documentation on-line <https://jupyter-notebook.readthedocs.io/en/latest/notebook.html>`_ ;
+-  **Interface graphique (« notebook ») :** démarrer `sage -n jupyter`; lire la
+   `documentation en ligne de Jupyter <https://jupyter-notebook.readthedocs.io/en/latest/notebook.html>`_ ;

But it's true that the current form clearly indicates that the on-line documentation of jupyter is in english.

comment:16 Changed 3 years ago by Dima Pasechnik

I'm surprised in fact that Jupyther has no localised docs, but I can't find any, at least nothing official.

comment:17 Changed 3 years ago by David Coudert

At least it has a documentation, while today many software have no docs at all (and don't expect proper comments in the code).

comment:18 Changed 3 years ago by git

Commit: 88dd95f9268022d0c959c4b660a3a2450c48b7b69c171a6d0aa15d2cb9c818c303c32f06c99ca7b9

Branch pushed to git repo; I updated commit sha1. This was a forced push. Last 10 new commits:

f77cfacsrc/doc/bootstrap: Create the directory src/doc/en/reference/repl if it does not exist
7ce0a30build/bin/write-dockerfile.sh: ADD src/bin for bootstrapping, needed by src/doc/bootstrap after #29884
cf2de90remove sagenb docs
a209a5dmore traces of sws
f728459rest of the traces of sws
f67984fremoved _section-notebook and rewrote
171195egoogle-translated for es/fr/ja/pt
3e346edcomplete rebase by stripping last bits of sws
81499c9fix DE typo
9c171a6small fixes to the tutorial in spanish

comment:19 Changed 3 years ago by Dima Pasechnik

Work issues: fix fr,pt,es, ja files, and src/mac-app/fix pt,ja files

rebased over the latest copy of #21559 (and latest 9.2.beta4)

comment:20 Changed 3 years ago by Dima Pasechnik

macOS app to be fixed on #30099

comment:21 Changed 3 years ago by John Palmieri

When I look at the branch on trac, the last entry is a new file "t", containing

if test x`locale -a | grep C\.UTF-8` != x; then
 export LC_ALL=C.UTF-8;
else
 export LC_ALL=C;
fi

echo $LC_ALL

Is that supposed to be there?

Otherwise, I think we should merge this and fix the remaining languages later.

comment:22 Changed 3 years ago by git

Commit: 9c171a6d0aa15d2cb9c818c303c32f06c99ca7b9cd421040539e989ee9e115fd3220ec1bda64eedd

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

d4dbeaeremove sagenb docs
fd48549more traces of sws
89a1b10rest of the traces of sws
b2d66ffremoved _section-notebook and rewrote
b42bae2google-translated for es/fr/ja/pt
e7f6981complete rebase by stripping last bits of sws
979aaa7fix DE typo
2d962easmall fixes to the tutorial in spanish
cd42104remove stray file

comment:23 Changed 3 years ago by Dima Pasechnik

rebased over latest beta and removed t

comment:24 Changed 3 years ago by John Palmieri

Reviewers: Matthias Koeppe, Reimundo HeluaniMatthias Koeppe, Reimundo Heluani, John Palmieri
Status: needs_reviewpositive_review

Good, thanks.

comment:25 Changed 3 years ago by Volker Braun

Branch: u/dimpase/docs/nosagenbdocscd421040539e989ee9e115fd3220ec1bda64eedd
Resolution: fixed
Status: positive_reviewclosed

comment:26 Changed 2 years ago by Samuel Lelièvre

Commit: cd421040539e989ee9e115fd3220ec1bda64eedd

Sorry I didn't pay attention to this ticket in the past month and only realise now...

I would have suggested to keep the "sws to other formats" converters for a year.

This would give time to migrate legacy worksheets, matching our one-year deprecation period.

Of course, people can always download Sage 9.1, or find it on CoCalc... for a while.

comment:27 Changed 2 years ago by Dima Pasechnik

converters are still there.

Only the already broken sws<->rst converters are removed here.

Last edited 2 years ago by Dima Pasechnik (previous) (diff)
Note: See TracTickets for help on using tickets.