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

[doc] Include files from included files in subdirectories needs documenting #19

Open
jsseidel opened this issue Feb 28, 2019 · 0 comments

Comments

@jsseidel
Copy link
Collaborator

In the following case, mktechdocs will fail to build because included files in subdirectories must give a path relative to the project directory rather than the included subdirectory.

myproject
    |
    +----> master.md
    +----> subdir1
               |
               + ----> somedoc.md
               |
               + ---- > included.md

In this case, master.md might be:

```include
subdir1/somedoc.md
````

And, you might think somedoc.md should be:

```include
included.md
```

But this won't build correctly. Mktechdocs will skip included.md because it can't find it. Instead, somedoc.md should be:

```include
subdir1/included.md
```

This may or may not be ideal, but it should at least be documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant