Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Put Argus documentation on readthedocs #214

Closed
katsel opened this issue Nov 24, 2020 · 3 comments · Fixed by #233
Closed

Put Argus documentation on readthedocs #214

katsel opened this issue Nov 24, 2020 · 3 comments · Fixed by #233
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@katsel
Copy link
Contributor

katsel commented Nov 24, 2020

Argus documentation should be available on readthedocs.

argus.readthedocs.io is registered to a different project, so I suggest argus-server as a name (as on pypi).

Afterwards, point documentation links in the README to readthedocs.

@katsel katsel added the documentation Improvements or additions to documentation label Nov 24, 2020
@hmpf
Copy link
Contributor

hmpf commented Nov 24, 2020

Existing rtd, not renamed: https://readthedocs.org/projects/aas/

I've applied to get the project slug changed, here: readthedocs/readthedocs.org#7696

@katsel
Copy link
Contributor Author

katsel commented Nov 26, 2020

Oh. Stumbled across another mini-issue that's related to this one.

The PyPI README has some broken links because it cannot find the docs/ folder there!

Let's count that as another reason to get readthedocs running, and use absolute links on the README.

@katsel katsel added this to To do in Argus sprint week 50/51 (#4) via automation Dec 9, 2020
@katsel katsel added this to the Version 1.1 milestone Dec 9, 2020
@katsel
Copy link
Contributor Author

katsel commented Dec 9, 2020

@hmpf hmpf moved this from To do to In progress in Argus sprint week 50/51 (#4) Dec 10, 2020
Argus sprint week 50/51 (#4) automation moved this from In progress to Done Dec 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants