GSoC:Fix docs installation workflow errors

[sakirr05]

Fix documentation errors in setup/installation guide

📝 Description

Type: 📝 documentation

This PR fixes four documentation bugs reported in the TARDIS setup/installation and developer workflow guides

Fixes #3450

Changes:

1. Duplicate installation page
   The installation page was reachable at two URLs (/installation.html and /getting_started/installation.html), causing confusion. A redirect was added in docs/conf.py so that the root installation.html redirects to the canonical page getting_started/installation.html.

   Example (redirect config in docs/conf.py):

   redirects = [
       ("using/gui/index.rst", "using/visualization/index.rst"),
       ("installation.rst", "getting_started/installation.rst"),  # added
   ]

2. Broken quickstart link
   The installation page linked to quickstart.ipynb, which resolved to a non-existent path under getting_started/. The link was updated to use the correct doc reference so it points to the quickstart notebook at the docs root.

   Before: Quickstart for TARDIS <quickstart.ipynb>_
   After: :doc:\Quickstart for TARDIS <../quickstart>``

3. Missing tardisbase install step
   The developer workflow at contributing/development/git_workflow.html#in-detail did not mention installing tardisbase, which is required for running regression tests. A step was added after “Install TARDIS in develop mode”.

   Added in docs/contributing/development/git_workflow.rst:

   #. Install the ``tardisbase`` package (required for running TARDIS regression
      tests) and optionally ``viz`` (for visualization tools)::
   
       $ pip install -e ".[tardisbase,viz]"
   
   Or install only ``tardisbase``::
   
       $ pip install -e ".[tardisbase]"

4. Wrong cd command
   In the “In detail” section of the developer workflow, a bare cd (no argument) was shown before git remote add upstream, which would change directory to the user’s home instead of staying in the repo. That stray cd line was removed so the instruction is only git remote add upstream ... (users are already in the repo from the previous cd tardis step).

   Before:

   cd
   git remote add upstream git://github.com/tardis-sn/tardis.git

   After:

   git remote add upstream git://github.com/tardis-sn/tardis.git

Additional fix: The Installation guide link in the developer workflow was updated from ../../installation to ../../getting_started/installation, and the “Environment update” section in the installation page now uses an internal ref (:ref:\above ``) instead of the old root URL.

---

📌 Resources

• Issue: Fix documentation errors in setup/installation guide #3450
• Installation (canonical): https://tardis-sn.github.io/tardis/getting_started/installation.html
• Developer workflow: https://tardis-sn.github.io/tardis/contributing/development/git_workflow.html#in-detail

---

🚦 Testing

How did you test these changes?

• Testing pipeline
• Other method (describe): Documentation-only change. Verified by:
  • Inspecting RST and conf.py edits for correctness and link targets.
  • Confirming redirect entry and doc refs match existing Sphinx/redirect setup.
  • No Python or test code was modified; CI will build docs when the build_docs label is applied.
• My changes can't be tested (explain why)

---

☑️ Checklist

• I requested two reviewers for this pull request
• I updated the documentation according to my changes
• I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

[tardis-bot]

*beep* *bop*
Hi human,
I ran ruff on the latest commit (bccdf69).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

Details

18830	      	[ ] syntax-error
 17	W293  	[ ] blank-line-with-whitespace
 13	E701  	[ ] multiple-statements-on-one-line-colon
  9	W291  	[ ] trailing-whitespace
  5	E702  	[ ] multiple-statements-on-one-line-semicolon
  5	F405  	[ ] undefined-local-with-import-star-usage
  4	COM818	[ ] trailing-comma-on-bare-tuple
  3	E402  	[ ] module-import-not-at-top-of-file
  3	UP015 	[*] redundant-open-modes
  2	D209  	[*] new-line-after-last-paragraph
  2	I001  	[*] unsorted-imports
  1	E712  	[ ] true-false-comparison
  1	D202  	[*] blank-line-after-function
  1	DTZ011	[ ] call-date-today
  1	F401  	[*] unused-import
  1	INP001	[ ] implicit-namespace-package
  1	PGH004	[ ] blanket-noqa
  1	S113  	[ ] request-without-timeout
  1	UP009 	[*] utf8-encoding-declaration
  1	UP030 	[ ] format-literals
  1	UP032 	[*] f-string
  1	UP034 	[ ] extraneous-parentheses
Found 18904 errors.
[*] 11 fixable with the `--fix` option (5 hidden fixes can be enabled with the `--unsafe-fixes` option).

Complete output(might be large):

Details

.ci-helpers/update_credits.py:1:1: INP001 File `.ci-helpers/update_credits.py` is part of an implicit namespace package. Add an `__init__.py`.
.ci-helpers/update_credits.py:1:1: D209 [*] Multi-line docstring closing quotes should be on a separate line
.ci-helpers/update_credits.py:15:5: D202 [*] No blank lines allowed after function docstring (found 1)
.ci-helpers/update_credits.py:15:5: D209 [*] Multi-line docstring closing quotes should be on a separate line
.ci-helpers/update_credits.py:20:12: DTZ011 `datetime.date.today()` used
.ci-helpers/update_credits.py:24:20: S113 Probable use of `requests` call without timeout
.ci-helpers/update_credits.py:46:91: W291 Trailing whitespace
docs/conf.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary
docs/conf.py:27:1: I001 [*] Import block is un-sorted or un-formatted
docs/conf.py:30:8: F401 [*] `tardis` imported but unused
docs/conf.py:35:1: I001 [*] Import block is un-sorted or un-formatted
docs/conf.py:40:43: PGH004 Use specific rule codes when using `noqa`
docs/conf.py:50:27: UP015 [*] Unnecessary mode argument
docs/conf.py:71:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:72:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:73:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:74:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:75:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:143:1: W293 Blank line contains whitespace
docs/conf.py:178:1: W293 Blank line contains whitespace
docs/conf.py:195:13: UP030 Use implicit references for positional format fields
docs/conf.py:195:13: UP032 [*] Use f-string instead of `format` call
docs/conf.py:222:1: E402 Module level import not at top of file
docs/conf.py:294:4: E712 Avoid equality comparisons to `True`; use `toml_config_tool_dict["tardis"]['edit_on_github']:` for truth checks
docs/conf.py:316:1: E402 Module level import not at top of file
docs/conf.py:369:1: E402 Module level import not at top of file
docs/conf.py:384:37: UP015 [*] Unnecessary modes, use `w`
docs/conf.py:399:37: UP015 [*] Unnecessary modes, use `w`
Found 28 errors.
[*] 11 fixable with the `--fix` option (5 hidden fixes can be enabled with the `--unsafe-fixes` option).

[tardis-bot]

*beep* *bop*

Hi, human.

The docs workflow has failed ❌

Click here to see the build log.