Skip to content

Commit

Permalink
chore: add readthedocs and mkdocs configs
Browse files Browse the repository at this point in the history
- Add .readthedocs.yaml
- Add mkdocs.yml
  • Loading branch information
miurahr committed Apr 1, 2024
1 parent 17df381 commit 01ae1c4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.12"

mkdocs:
configuration: mkdocs.yml
17 changes: 17 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
site_name: VLDocking library
repo_url: https://github.com/omegat-org/vldocking
docs_dir: wiki
nav:
- 1. Getting started: 'tutorial1.md'
- 1a. And now... Docking!: 'tutorial1page2.md'
- 2. Customizing layout: 'tutorial2.md'
- 3. Events: 'tutorial3.md'
- 4. Workspaces: 'tutorial4.md'
- 5. Extending VLDocking: 'tutorial5.md'
- 6. Tips & Tricks: 'tutorial6.md'
- 7. Heavyweight components: 'tutorial7.md'
- 8. Customizing the UI: 'tutorial8.md'
- 9. Toolbars: 'tutorial9.md'
- 10. Compound dockables: 'tutorial10.md'
- 11. Multi-desktop applications: 'tutorial11.md'
- 12. Anchored dockables: 'tutorial12.md'

0 comments on commit 01ae1c4

Please sign in to comment.