Skip to content

Doc: move existing links from 'silx.org' to 'readthedocs'#4612

Open
payno wants to merge 2 commits into
mainfrom
4304-silx-pin-point-documentation-to-readthedocs
Open

Doc: move existing links from 'silx.org' to 'readthedocs'#4612
payno wants to merge 2 commits into
mainfrom
4304-silx-pin-point-documentation-to-readthedocs

Conversation

@payno

@payno payno commented Jun 15, 2026

Copy link
Copy Markdown
Member

Closes #4304

PR summary

This PR is linked to moving documentation officialy to readthedocs. It update a set of link from silx.org

AI Disclosure

  • No AI used
  • AI tool(s) ... used for ...

Operation done at edna-site (helped by AI :( ):

  • added a .htaccess at ../doc/silx/latest to do the redirection
# Redirect silx.org/doc/silx/latest/ to silx.readthedocs.io/en/stable
RewriteEngine On

RewriteRule ^(.*)$ https://silx.readthedocs.io/en/stable/$1 [R=301,L]
  • Added a specific configuration for silx to allow redirection for both http and https
<VirtualHost *:443>
    ...
    DocumentRoot /var/www/silx

    ...
    <Directory /var/www/silx/doc/silx/latest>
        Options Indexes FollowSymLinks
        AllowOverride FileInfo
        Require all granted
    </Directory>

    SSLEngine on

    ...
</VirtualHost>

And then we need to restart apache2 sudo systemctl restart apache2

✔️ Checked that other docs are not modified by this modification

@payno payno linked an issue Jun 15, 2026 that may be closed by this pull request
@payno payno marked this pull request as draft June 15, 2026 09:12
@payno payno force-pushed the 4304-silx-pin-point-documentation-to-readthedocs branch from 56ce06c to 39b1aab Compare June 15, 2026 12:34
@payno payno marked this pull request as ready for review June 15, 2026 12:35
@payno payno requested a review from a team June 15, 2026 12:36
Comment thread doc/source/overview.rst
- `Conda package on conda-forge channel <https://anaconda.org/conda-forge/silx>`_
- Windows application installer `on github release page <https://github.com/silx-kit/silx/releases/latest/>`_ (available in the `Assets` at the bottom).
- `Documentation on silx.org <http://www.silx.org/doc/silx/latest/>`_
- `Documentation on silx.org <https://silx.readthedocs.io/en/latest/>`_

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `Documentation on silx.org <https://silx.readthedocs.io/en/latest/>`_
- `Documentation on Read The Docs <https://silx.readthedocs.io/en/latest/>`_

Comment thread src/silx/__init__.py
- silx.utils: Miscellaneous convenient functions
See silx documentation: http://www.silx.org/doc/silx/latest/
See silx documentation: https://silx.readthedocs.io/en/latest/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I would remove these. I feel it does not add much.

@payno payno force-pushed the 4304-silx-pin-point-documentation-to-readthedocs branch from 39b1aab to a7c4f26 Compare June 16, 2026 07:37
@payno payno enabled auto-merge June 16, 2026 07:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Silx: Redirect documentation from edna-site to readthedocs

2 participants