Skip to content

Commit

Permalink
Site/move options location (#16)
Browse files Browse the repository at this point in the history
* Moved the options documentation out of the 'documentation' directory to the top level of 'docs'.

* Removed an old module that isn't used any more and added some more filters to the documentation library so mkdocs doesn't get files that aren't being used.

* Forgot to change the build step in the site derivation.
  • Loading branch information
djacu authored Feb 7, 2024
1 parent 599fd3b commit ff7ed86
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 79 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ site/.cache
!site/docs/examples/index.md
site/docs/examples/
# Options docs are included during nix build
site/docs/documentation/modules/
site/docs/modules/
2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
nativeBuildInputs = [site-env];

buildPhase = ''
cp -r ${moduleMarkdownDocs}/* ./docs/documentation/
cp -r ${moduleMarkdownDocs}/* ./docs/
cp -r ${examplePdfDocs}/* ./docs/
ls -FhoAR
mkdocs build --site-dir dist
Expand Down
9 changes: 6 additions & 3 deletions lib/documentation.nix
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
modulesDir ? self + "/modules",
pathFilter ? [
"component"
"biblatex/common"
"enumitem/setlistOptions"
"templates/default"
],
...
}: (
Expand Down Expand Up @@ -377,8 +380,8 @@
''
#!/usr/bin/env bash
nix build .\#moduleMarkdownDocs
rm -rf site/docs/documentation/modules/*
cp -r ./result/* ./site/docs/documentation/
chmod +w -R ./site/docs/documentation/modules
rm -rf site/docs/modules/*
cp -r ./result/* ./site/docs/
chmod +w -R ./site/docs/modules
'';
}
49 changes: 0 additions & 49 deletions modules/templates/misc.nix

This file was deleted.

50 changes: 25 additions & 25 deletions site/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,44 @@ nav:
- examples/bibliography.md
- Options:
- Top:
- documentation/modules/top/nixcv.md
- documentation/modules/top/cv.md
- modules/top/nixcv.md
- modules/top/cv.md
- Sections:
- documentation/modules/sections/section.md
- documentation/modules/sections/personal.md
- modules/sections/section.md
- modules/sections/personal.md
- Lists:
- documentation/modules/lists/itemlist.md
- documentation/modules/lists/item.md
- documentation/modules/lists/items.md
- documentation/modules/lists/profile.md
- modules/lists/itemlist.md
- modules/lists/item.md
- modules/lists/items.md
- modules/lists/profile.md
- Text:
- documentation/modules/text/text.md
- documentation/modules/text/paragraphs.md
- modules/text/text.md
- modules/text/paragraphs.md
- Skills:
- documentation/modules/skills/skills.md
- documentation/modules/skills/skill.md
- modules/skills/skills.md
- modules/skills/skill.md
- Bibliography:
- documentation/modules/biblatex/bibliography.md
- modules/biblatex/bibliography.md
- Templates:
- documentation/modules/templates/templates.md
- documentation/modules/templates/layout.md
- modules/templates/templates.md
- modules/templates/layout.md
- TemplatesContent:
- documentation/modules/templates/templatesContent.md
- modules/templates/templatesContent.md
- enumitem:
- documentation/modules/enumitem/enumitem.md
- documentation/modules/enumitem/newlist.md
- documentation/modules/enumitem/setlist.md
- modules/enumitem/enumitem.md
- modules/enumitem/newlist.md
- modules/enumitem/setlist.md
- environments:
- documentation/modules/templates/newenvironment.md
- modules/templates/newenvironment.md
- latex:
- documentation/modules/templates/rawlatex.md
- modules/templates/rawlatex.md
- packages:
- documentation/modules/templates/packages.md
- modules/templates/packages.md
- titlesec:
- documentation/modules/titlesec/titleformat.md
- modules/titlesec/titleformat.md
- Bibresources:
- documentation/modules/biblatex/bibresources.md
- documentation/modules/biblatex/online.md
- modules/biblatex/bibresources.md
- modules/biblatex/online.md
- Blog:
- blog/index.md

Expand Down

1 comment on commit ff7ed86

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.