agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix gitlab links to documentation

Browse source
This commit is contained in:
benjamin melançon 2023-09-25 18:53:11 -04:00
parent d31516cf1c
commit d61f414387
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
conf.py
View file

@ -125,7 +125,7 @@ html_context = {
"display_gitlab": True, # Integrate Gitlab
"gitlab_user": "agaric", # Organization
"gitlab_repo": "documentation", # Repo name
"gitlab_version": "master", # Version
"gitlab_version": "main", # Version
"conf_py_path": "/", # Path in the checkout to the docs root
}

2
documentation.md
View file

@ -2,7 +2,7 @@
Welcome to the meta section of our documentation where we document how to do documentation!
Edit or add. That's the primary instruction. You can edit directly on [gitlab.com/agaric/documentation](https://gitlab.com/agaric/documentation) (for example, the edit link on this page takes you to [gitlab.com/agaric/documentation/blob/master/documentation.md](https://gitlab.com/agaric/documentation/blob/master/documentation.md)). If you aren't a member of Agaric, GitLab will helpfully offer to fork the documentation to your own namespace so that you can make a merge request with your documentation suggestion.
Edit or add. That's the primary instruction. You can edit directly on [gitlab.com/agaric/documentation](https://gitlab.com/agaric/documentation) (for example, the edit link on this page takes you to [gitlab.com/agaric/documentation/blob/main/documentation.md](https://gitlab.com/agaric/documentation/blob/main/documentation.md)). If you aren't a member of Agaric, GitLab will helpfully offer to fork the documentation to your own namespace so that you can make a merge request with your documentation suggestion.
```{tip}
This documentation page is a good one to copy or refer to for an example of MyST formatting. And of course anyone can come and clean up formatting later.