Skip to content

Commit

Permalink
Update requirements.txt to fix failing (#468)
Browse files Browse the repository at this point in the history
* Chore: Update requirements.txt to fix failing

Also, update the installation command in the README.md file to use "--use-pep517" flag for pip install.

* Add older weasyprint 0.44 to fix mkdocs-with-pdf depricated warmimg

* chore: Update copyright year to 2024 and added - search in mkArmbianDocs.py

* Update copyright year to 2024 and add - search in mkArmbianDocs.py

* chore: Add mdx_truly_sane_lists markdown extension

* generated yml
  • Loading branch information
Tearran authored Aug 7, 2024
1 parent d49213e commit 14e93c7
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 93 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Set up a Python virtual environment to isolate the project dependencies:
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install --use-pep517 -r requirements.txt
```

### Building and Serving the Documentation
Expand Down
182 changes: 98 additions & 84 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@

site_name: Armbian Documentation
site_author: "Armbian team"

copyright: Copyright © 2015 - 2024 Armbian team
repo_url: https://github.com/armbian/documentation
repo_name: armbian/documentation

theme:
name: material
custom_dir: overrides
logo: images/logo.svg
icon:
repo: fontawesome/brands/github-alt
palette:
- scheme: default
primary: red
accent: red
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
favicon: images/logo.png
features:
- navigation.tabs
- navigation.top
- toc.integrate
theme:
name: material
custom_dir: overrides
logo: images/logo.svg
icon:
repo: fontawesome/brands/github-alt
palette:
- scheme: default
primary: red
accent: red
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
favicon: images/logo.png
features:
- navigation.tabs
- navigation.top
- toc.integrate

extra:
analytics:
Expand All @@ -41,12 +42,12 @@ extra:
link: https://twitter.com/armbian

plugins:
- search
- with-pdf:
author: Armbian documentation team
copyright: © 2024 by Armbian
cover_title: Armbian documentation
cover_subtitle: Linux for ARM development boards
- search
- with-pdf:
author: Armbian documentation team
copyright: © 2024 by Armbian
cover_title: Armbian documentation
cover_subtitle: Linux for ARM development boards

markdown_extensions:
- smarty
Expand All @@ -60,61 +61,74 @@ markdown_extensions:
use_pygments: true
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
- Home: index.md
- 'Board' :
- 'Maintainers_Procedures_and_Guidelines' : 'Board_Maintainers_Procedures_and_Guidelines.md'

- 'Community' :
- 'Governance' : 'Community_Governance.md'
- 'IRC' : 'Community_IRC.md'
- 'Torrent' : 'Community_Torrent.md'

- 'Developer Guide' :
- 'User Configurations' : 'Developer-Guide_User-Configurations.md'
- 'Extensions Hooks' : 'Developer-Guide_Extensions-Hooks.md'
- 'Welcome' : 'Developer-Guide_Welcome.md'
- 'Build Process' : 'Developer-Guide_Build-Process.md'
- 'Building with Multipass' : 'Developer-Guide_Building-with-Multipass.md'
- 'Build Options' : 'Developer-Guide_Build-Options.md'
- 'Building with Docker' : 'Developer-Guide_Building-with-Docker.md'
- 'Adding Board Family' : 'Developer-Guide_Adding-Board-Family.md'
- 'Extensions' : 'Developer-Guide_Extensions.md'
- 'Testing Procedures' : 'Developer-Guide_Testing-Procedures.md'
- 'Build Preparation' : 'Developer-Guide_Build-Preparation.md'

- 'Development Code' :
- 'Review_Procedures_and_Guidelines' : 'Development-Code_Review_Procedures_and_Guidelines.md'

- 'Hardware' :
- 'Marvell' : 'Hardware_Marvell.md'
- 'Allwinner A20' : 'Hardware_Allwinner-A20.md'
- 'Rockchip' : 'Hardware_Rockchip.md'
- 'Allwinner H5 A64' : 'Hardware_Allwinner-H5-A64.md'
- 'Allwinner' : 'Hardware_Allwinner.md'
- 'Allwinner H3' : 'Hardware_Allwinner-H3.md'
- 'Allwinner H6' : 'Hardware_Allwinner-H6.md'
- 'Freescale imx6' : 'Hardware_Freescale-imx6.md'

- 'Process' :
- 'Documentation' : 'Process_Documentation.md'
- 'Contribute' : 'Process_Contribute.md'
- 'CI' : 'Process_CI.md'
- 'Managing_Workflow' : 'Process_Managing_Workflow.md'
- 'Armbian Task Tracking' : 'Process_Armbian-Task-Tracking.md'
- 'Merge Policy' : 'Process_Merge-Policy.md'
- 'Release Model' : 'Process_Release-Model.md'

- 'Quick' :
- 'facts' : 'Quick_facts.md'

- 'Release' :
- 'Changelog' : 'Release_Changelog.md'
- 'Board Maintainers' : 'Release_Board-Maintainers.md'

- 'User Guide' :
- 'FAQ' : 'User-Guide_FAQ.md'
- 'Getting Started' : 'User-Guide_Getting-Started.md'
- 'Recovery' : 'User-Guide_Recovery.md'
- 'Allwinner_overlays' : 'User-Guide_Allwinner_overlays.md'
- 'Armbian Config' : 'User-Guide_Armbian-Config.md'
- 'Basic Troubleshooting' : 'User-Guide_Basic-Troubleshooting.md'
- 'Getting Started Download Page' : 'User-Guide_Getting-Started-Download-Page.md'
- 'Migration_from_Bananian' : 'User-Guide_Migration_from_Bananian.md'
- 'Fine Tuning' : 'User-Guide_Fine-Tuning.md'
- 'Board Support Rules' : 'User-Guide_Board-Support-Rules.md'
- 'Advanced Features' : 'User-Guide_Advanced-Features.md'
- 'Networking' : 'User-Guide_Networking.md'
- 'Armbian_overlays' : 'User-Guide_Armbian_overlays.md'


- "User Guide":
- "Getting Started": "User-Guide_Getting-Started.md"
- "Quick facts": "Quick_facts.md"
- "Troubleshooting": "User-Guide_Basic-Troubleshooting.md"
- "Recovery": "User-Guide_Recovery.md"
- "Frequently asked questions": "User-Guide_FAQ.md"
- "Advanced Features": "User-Guide_Advanced-Features.md"
- "Fine Tuning": "User-Guide_Fine-Tuning.md"
- "Networking": "User-Guide_Networking.md"
- "Armbian config": "User-Guide_Armbian-Config.md"
- "Armbian DT overlays": "User-Guide_Armbian_overlays.md"
- "Board Support Rules": "User-Guide_Board-Support-Rules.md"

- "Hardware Notes":
- "Allwinner (Generic)": "Hardware_Allwinner.md"
- "A10 and A20": "Hardware_Allwinner-A20.md"
- "H2+ and H3": "Hardware_Allwinner-H3.md"
- "H5 and A64": "Hardware_Allwinner-H5-A64.md"
- "H6": "Hardware_Allwinner-H6.md"
- "Freescale i.MX6": "Hardware_Freescale-imx6.md"
- "Marvell Armada": "Hardware_Marvell.md"
- "Rockchip": "Hardware_Rockchip.md"

- "Developer Guide":
- "Welcome": "Developer-Guide_Welcome.md"
- "Building Armbian": "Developer-Guide_Build-Preparation.md"
- "Building with Docker": "Developer-Guide_Building-with-Docker.md"
- "Build Options": "Developer-Guide_Build-Options.md"
- "User Configurations": "Developer-Guide_User-Configurations.md"
- "Extensions": "Developer-Guide_Extensions.md"
- "Hooks": "Developer-Guide_Extensions-Hooks.md" # This file is autogenerated by build system.
- "Adding new board or family": "Developer-Guide_Adding-Board-Family.md"

- "Contributor Process":
- "Contribute": "Process_Contribute.md"
- "Merge Policy": "Process_Merge-Policy.md"
- "Continuous integration": "Process_CI.md"
- "Documentation": "Process_Documentation.md"
- "Development Code Review Procedures and Guidelines": "Development-Code_Review_Procedures_and_Guidelines.md"

- "Release management":
- "Model": "Process_Release-Model.md"
- "Changelog": "Release_Changelog.md"
- "Workflow (Jira)": "Process_Managing_Workflow.md"
- "Board Maintainers": "Release_Board-Maintainers.md"
- "Board Maintainers Procedures and Guidelines": "Board_Maintainers_Procedures_and_Guidelines.md"


- "Community":
- "IRC/Discord/Matrix": "Community_IRC.md"
- "Governance": "Community_Governance.md"
- "Seed our torrents": "Community_Torrent.md"
9 changes: 5 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Jinja2~=3.1.1
markdown>=3.2
mkdocs>=1.3.0
mkdocs-material>=8.0.0
Jinja2~=3.1.4
markdown>=3.6
mkdocs>=1.6.0
mkdocs-material>=9.5.31
mkdocs-with-pdf>=0.9.3
mdx_truly_sane_lists>=1.3.0
weasyprint==44
10 changes: 6 additions & 4 deletions tools/mkArmbianDocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def generateSite(parsedFileList):
site_name: Armbian Documentation
site_author: "Armbian team"
copyright: Copyright © 2015 - 2022 Armbian team
copyright: Copyright © 2015 - 2024 Armbian team
repo_url: https://github.com/armbian/documentation
repo_name: armbian/documentation
Expand Down Expand Up @@ -119,15 +119,17 @@ def generateSite(parsedFileList):
link: https://twitter.com/armbian
plugins:
- search
- with-pdf:
author: Armbian documentation team
copyright: © 2021 by Armbian
copyright: © 2024 by Armbian
cover_title: Armbian documentation
cover_subtitle: Linux for ARM development boards
markdown_extensions:
- smarty
- footnotes
- mdx_truly_sane_lists
- toc:
permalink: True
- pymdownx.highlight:
Expand All @@ -136,8 +138,8 @@ def generateSite(parsedFileList):
use_pygments: true
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
- Home: index.md
Expand Down

0 comments on commit 14e93c7

Please sign in to comment.