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

Add mkdocs folder for clarity #227

Merged
merged 1 commit into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/mkdocs.yaml → .github/mkdocs/mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
site_name: SciCatLive
docs_dir: ../docs
docs_dir: ../../docs
theme:
name: material
custom_dir: overrides
Expand Down Expand Up @@ -31,4 +31,4 @@ markdown_extensions:
emoji_generator: !!python/name:material.extensions.emoji.to_svg

hooks:
- mkdocs_relative_to.py
- relative_to.py
File renamed without changes.
File renamed without changes.
42 changes: 42 additions & 0 deletions .github/mkdocs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Babel==2.15.0
beautifulsoup4==4.12.3
bracex==2.4
certifi==2024.7.4
charset-normalizer==3.3.2
click==8.1.7
colorama==0.4.6
ghp-import==2.1.0
idna==3.7
importlib_metadata==8.0.0
importlib_resources==6.4.0
Jinja2==3.1.4
lxml==5.2.2
Markdown==3.6
MarkupSafe==2.1.5
mergedeep==1.3.4
mike==2.1.2
mkdocs==1.6.0
mkdocs-awesome-pages-plugin==2.9.2
mkdocs-get-deps==0.2.0
mkdocs-material==9.5.29
mkdocs-material-extensions==1.3.1
natsort==8.4.0
packaging==24.1
paginate==0.5.6
pathspec==0.12.1
platformdirs==4.2.2
Pygments==2.18.0
pymdown-extensions==10.8.1
pyparsing==3.1.2
python-dateutil==2.9.0.post0
PyYAML==6.0.1
pyyaml_env_tag==0.1
regex==2024.5.15
requests==2.32.3
six==1.16.0
soupsieve==2.5
urllib3==2.2.2
verspec==0.1.0
watchdog==4.0.1
wcmatch==8.5.2
zipp==3.19.2
5 changes: 2 additions & 3 deletions .github/workflows/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ jobs:

- name: Install dependencies
run: |
pip install mkdocs mkdocs-material mike \
mkdocs-awesome-pages-plugin beautifulsoup4 lxml
pip install -r .github/mkdocs/requirements.txt

- name: Copy all to docs folder
run: |
Expand Down Expand Up @@ -51,4 +50,4 @@ jobs:
GIT_COMMITTER_EMAIL: [email protected]
BASE_URL: https://github.com/SciCatProject/scicatlive/blob
DOCS_BRANCH: gh-pages
DOCS_CONFIG: .github/mkdocs.yaml
DOCS_CONFIG: .github/mkdocs/mkdocs.yaml
Loading