gazebosim / gazebosim/docs

Old API docs are no longer available

Open
#467 0 comments 0 reactions 1 assignee Claimed by @azeey View on GitHub
bug
Dominant language
Python
Stars
88
Forks
319
Avg merge
2h 2m
Merged PRs (30d)
1

Description

With the new website deployment implemented in #441, old API docs (e.g. https://gazebosim.org/api/transport/9.0/tutorials.html) are no longer available. This has caused a some broken links (see https://github.com/gazebosim/docs/pull/466 and https://github.com/gazebosim/docs/pull/461). My plan is to manually import them from AWS, but the total size is about 9GB. This is mainly because we used to generate API docs for minor versions as shown below.

Directory structure of API docs

```
~/tmp/api on  main ❯ tree -L 2
.
├── cmake
│   ├── 2
│   ├── 3
│   └── 4
├── common
│   ├── 0
│   ├── 0.1
│   ├── 0.2
│   ├── 0.3
│   ├── 0.4
│   ├── 1.0
│   ├── 2.0
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.10
│   ├── 3.11
│   ├── 3.12
│   ├── 3.13
│   ├── 3.14
│   ├── 3.3
│   ├── 3.5
│   ├── 3.6
│   ├── 3.7
│   ├── 3.8
│   ├── 3.9
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 5
│   └── 6
├── fuel_tools
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 7
│   ├── 7.0
│   ├── 8
│   ├── 8.0
│   └── 9
├── gazebo
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 2
│   ├── 2.0
│   ├── 2.10
│   ├── 2.16
│   ├── 2.23
│   ├── 2.24
│   ├── 2.25
│   ├── 3
│   ├── 3.0
│   ├── 3.10
│   ├── 3.11
│   ├── 3.12
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 3.6
│   ├── 3.7
│   ├── 3.8
│   ├── 3.9
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.10
│   ├── 4.11
│   ├── 4.12
│   ├── 4.13
│   ├── 4.14
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 4.6
│   ├── 4.7
│   ├── 4.8
│   ├── 4.9
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 5.3
│   ├── 5.4
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 6.4
│   ├── 6.5
│   ├── 6.6
│   ├── 6.7
│   ├── 6.8
│   ├── 6.9
│   ├── 7
│   └── 7.0
├── gui
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.2
│   ├── 2.3
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 3.6
│   ├── 3.7
│   ├── 3.8
│   ├── 3.9
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 4.6
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 5.3
│   ├── 5.4
│   ├── 5.5
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 6.4
│   ├── 7
│   ├── 7.0
│   └── 8
├── launch
│   ├── 0
│   ├── 0.2
│   ├── 1
│   ├── 1.0
│   ├── 1.2
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.2
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   └── 7
├── math
│   ├── 0
│   ├── 0.1
│   ├── 0.2
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.2
│   ├── 2.3
│   ├── 2.4
│   ├── 2.5
│   ├── 2.6
│   ├── 2.7
│   ├── 2.8
│   ├── 3
│   ├── 3.1
│   ├── 3.2
│   ├── 4
│   ├── 4.0
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.10
│   ├── 6.2
│   ├── 6.4
│   ├── 6.5
│   ├── 6.6
│   ├── 6.7
│   ├── 6.8
│   ├── 6.9
│   ├── 7
│   └── 8
├── msgs
│   ├── 0
│   ├── 0.1
│   ├── 0.2
│   ├── 0.3
│   ├── 0.4
│   ├── 0.5
│   ├── 0.6
│   ├── 0.7
│   ├── 1
│   ├── 1.0
│   ├── 10
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 4
│   ├── 4.0
│   ├── 4.7
│   ├── 4.8
│   ├── 4.9
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.3
│   ├── 5.4
│   ├── 5.5
│   ├── 5.6
│   ├── 5.7
│   ├── 5.8
│   ├── 5.9
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 6.4
│   ├── 6.5
│   ├── 6.6
│   ├── 7
│   ├── 7.0
│   ├── 7.1
│   ├── 7.2
│   ├── 7.3
│   ├── 8
│   ├── 8.0
│   ├── 8.1
│   ├── 8.2
│   ├── 8.3
│   ├── 8.4
│   ├── 9
│   └── 9.0
├── physics
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 1.10
│   ├── 1.2
│   ├── 1.4
│   ├── 1.7
│   ├── 1.8
│   ├── 1.9
│   ├── 2
│   ├── 2.0
│   ├── 2.2
│   ├── 2.3
│   ├── 2.4
│   ├── 2.5
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   └── 7
├── plugin
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 1.2
│   └── 2
├── rendering
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 2.4
│   ├── 2.5
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 3.4
│   ├── 3.5
│   ├── 3.6
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 4.4
│   ├── 4.5
│   ├── 4.6
│   ├── 4.7
│   ├── 4.8
│   ├── 4.9
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 5.2
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 7
│   ├── 7.0
│   └── 8
├── sdformat
│   ├── 12
│   ├── 13
│   ├── 14
│   └── 9
├── sensors
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 2
│   ├── 2.0
│   ├── 2.6
│   ├── 2.8
│   ├── 2.9
│   ├── 3
│   ├── 3.0
│   ├── 3.1
│   ├── 3.2
│   ├── 3.3
│   ├── 4
│   ├── 4.0
│   ├── 4.1
│   ├── 4.2
│   ├── 4.3
│   ├── 5
│   ├── 5.0
│   ├── 5.1
│   ├── 6
│   ├── 6.0
│   ├── 6.1
│   ├── 6.2
│   ├── 6.3
│   ├── 7
│   ├── 7.0
│   └── 8
├── sim
│   ├── 0
│   ├── 0.1
│   ├── 1
│   ├── 1.0
│   ├── 1.1
│   ├── 2
│   ├── 2.0
│   ├── 2.10
│   ├── 2.16
│   ├── 2.23
│   ├── 2.24
│   ├── 2.25
│   ├── 3
│   ├── 4
│   ├── 5
│   ├── 6
│   ├── 7
│   └── 8
├── tools
│   ├── 1
│   └── 2
├── transport
│   ├── 0
│   ├── 0.3
│   ├── 0.4
│   ├── 0.5
│   ├── 0.6
│   ├── 0.7
│   ├── 0.8
│   ├── 0.9
│   ├── 1
│   ├── 1.0
│   ├── 10
│   ├── 10.0
│   ├── 10.1
│   ├── 10.2
│   ├── 1.1
│   ├── 11
│   ├── 11.0
│   ├── 1.2
│   ├── 12
│   ├── 12.0
│   ├── 1.3
│   ├── 13
│   ├── 1.4
│   ├── 2
│   ├── 2.0
│   ├── 2.1
│   ├── 3
│   ├── 3.0
│   ├── 4
│   ├── 4.0
│   ├── 5
│   ├── 5.0
│   ├── 6
│   ├── 6.0
│   ├── 7
│   ├── 7.0
│   ├── 7.1
│   ├── 7.4
│   ├── 7.5
│   ├── 8
│   ├── 8.0
│   ├── 8.1
│   ├── 8.2
│   ├── 9
│   ├── 9.0
│   └── 9.1
└── utils
├── 1
└── 2

```

My plan is to manually copy API docs from the major version directories and fix any broken links here if necessary.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.