FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs-template: small improvements by minijackson · Pull Request #6 · ControlSystemStudio/phoebus-codeathon · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .md  (3) .txt  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
1 change: 1 addition & 0 deletions documentation-tasks/template/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- Copy every file from the template to the root directory of your project, including hidden files, excluding the README.md
- Change the project name in `docs/pyproject.toml`
- Change the project name in `docs/conf.py`
- Change the project name and source code repository URL in `docs/index.md`
- Choose your profiles, remove the unneeded ones by:
- Removing the directory
- Removing the toctree in `docs/index.md`
Expand Down
9 changes: 9 additions & 0 deletions documentation-tasks/template/docs/changelog.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Unreleased

*Add your changes here.*
18 changes: 13 additions & 5 deletions documentation-tasks/template/docs/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Insert content here.

```{toctree}
:caption: Operator documentation
:caption: Operator
:maxdepth: 3
:glob:

Expand All @@ -14,7 +14,7 @@ operator/references/index
```

```{toctree}
:caption: Integrator documentation
:caption: Integrator
:maxdepth: 3
:glob:

Expand All @@ -25,7 +25,7 @@ integrator/references/index
```

```{toctree}
:caption: System admin documentation
:caption: System admin
:maxdepth: 3
:glob:

Expand All @@ -36,7 +36,7 @@ sysadmin/references/index
```

```{toctree}
:caption: Developer documentation
:caption: Developer
:maxdepth: 3
:glob:

Expand All @@ -47,7 +47,7 @@ developer/references/index
```

```{toctree}
:caption: Contributor documentation
:caption: Contributor
:maxdepth: 3
:glob:

Expand All @@ -56,3 +56,11 @@ contributor/guides/index
contributor/explanations/index
contributor/references/index
```

```{toctree}
:titlesonly:
:caption: Resources

changelog
Source code repository <https://github.com/Olog/phoebus-olog>
```
6 changes: 6 additions & 0 deletions documentation-tasks/template/docs/redirects.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# This file contains page redirections,
# so that we don't break URLs when renaming pages.
#
# For more information, see:
# https://sphinxext-rediraffe.readthedocs.io/en/latest/


Back | FazBrowse Home | New Git URL