Skip to content

Avoid needing double docs/docs #2

@vorburger

Description

@vorburger

Thank You for having created this project!

FYI I've come across it from https://flake.parts/options/mkdocs-flake

vorburger/nixfiles@e09630b adopted in a small project of mine.

One thing that initially caused me a bit of confusion, until I looked at the template, was that double docs/docs ... I know that MkDocs (apparently) likes to have its mkdocs.yaml at the same level as (so outside of) the docs/ directory.

I typically just put the mkdocs.yaml at the root of the git repo, and documentation "content" directly into docs/, e.g. here.

For some internal reason, when using this, that layout fails; example to reproduce:

$ git clone https://github.com/vorburger/nixfiles.git
$ cd nixfiles
$ git checkout e09630b3b2db4289c1692096433162d4cbe955b0
$ git mv docs/mkdocs.yml .
$ git mv docs/docs/* docs
$ rmdir docs/docs
$ nix build .#documentation
warning: Git tree '/home/vorburger/git/github.com/vorburger/nixfiles' has uncommitted changes
error: Cannot build '/nix/store/df92mabqzcnna3k8lz57bm4vcf1bkd6b-mkdocs-flake-documentation.drv'.
       Reason: builder failed with exit code 1.
       Output paths:
         /nix/store/ri8qmafk7d3qb3if3vmckv3w5z2j06n2-mkdocs-flake-documentation
       Last 1 log lines:
       > Error: Config file 'mkdocs.yml' does not exist.
       For full logs, run:
         nix log /nix/store/df92mabqzcnna3k8lz57bm4vcf1bkd6b-mkdocs-flake-documentation.drv

It's not a big issue, of course (once you know about the required double docs/docs), but I thought I'd let you know.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions