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

Migrate to Sphinx docs #118

Merged
merged 11 commits into from
Jul 29, 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/workflows/book-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ jobs:
- uses: cachix/install-nix-action@ba0dd844c9180cbf77aa72a116d6fbc515d0e87b # v27
- name: "Build documentation book"
run: |
nix build '.#book' --print-build-logs
cp -Lr --no-preserve=mode,ownership ./result/ ./book
nix build '.#docs' --print-build-logs
cp -Lr --no-preserve=mode,ownership ./result/share/doc/epnix/html ./book
- name: Setup Pages
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
- name: Upload artifact
Expand Down
8 changes: 4 additions & 4 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ formatting:
manpages:
stage: deploy
script:
- nix build $NIX_BUILD_FLAGS '.#manpages'
- cp -Lr ./result manpages
- nix build $NIX_BUILD_FLAGS '.#docs'
- cp -Lr ./result/share/man manpages
artifacts:
name: "manpages-$CI_COMMIT_REF_SLUG"
paths:
Expand All @@ -41,8 +41,8 @@ manpages:
pages:
stage: deploy
script:
- nix build $NIX_BUILD_FLAGS '.#book'
- cp -Lr ./result public
- nix build $NIX_BUILD_FLAGS '.#docs'
- cp -Lr ./result/share/doc/epnix/html public
artifacts:
name: "book"
paths:
Expand Down
6 changes: 3 additions & 3 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
StylesPath = doc/_vale
StylesPath = docs/_vale
MinAlertLevel = suggestion

Vocab = EPNix

# External packages
Packages = alex, Google, Microsoft, proselint, RedHat, write-good
# Only Markdown and .txt files; change to whatever you're using.
[*.md]

[*.{md,rst}]
# List of styles to load.
BasedOnStyles = alex, Google, Microsoft, proselint, RedHat, Vale, write-good

Expand Down
6 changes: 0 additions & 6 deletions doc/.gitignore

This file was deleted.

97 changes: 0 additions & 97 deletions doc/_quarto.yml

This file was deleted.

68 changes: 0 additions & 68 deletions doc/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions doc/ioc/developer-guides.md

This file was deleted.

5 changes: 0 additions & 5 deletions doc/ioc/developer-guides/glossary.md

This file was deleted.

5 changes: 0 additions & 5 deletions doc/ioc/developer-guides/guidelines.md

This file was deleted.

5 changes: 0 additions & 5 deletions doc/ioc/developer-guides/packaging-modules.md

This file was deleted.

5 changes: 0 additions & 5 deletions doc/ioc/developer-guides/packaging.md

This file was deleted.

7 changes: 0 additions & 7 deletions doc/ioc/developer-tutorials.md

This file was deleted.

7 changes: 0 additions & 7 deletions doc/ioc/explanations.md

This file was deleted.

49 changes: 0 additions & 49 deletions doc/ioc/faq.md

This file was deleted.

7 changes: 0 additions & 7 deletions doc/ioc/guides.md

This file was deleted.

Loading