Giter Club home page Giter Club logo

Comments (5)

neerdoc avatar neerdoc commented on June 9, 2024

Hi @MarcelGep,

I will look into it. Does it work with other output formats? E.g., if you use --markdown instead of --latex.

Kindly,
Gustav

from doorstop.

neerdoc avatar neerdoc commented on June 9, 2024

Hi @MarcelGep,

the problem is only very bad documentation from my part.

The --template flag is ment to set the name of the selected template only. You cannot place it anywhere other than in the template folder under the document structure. The reasoning behind that was simply to copy the methodology of the assets folder.

So, in your case: doorstop publish all ./dist --latex --template TEMPLATE_NAME means that you are actually trying to publish all documents in the standard doorstop folder, i.e., ./reqs. To correctly supply a custom template, you have to create a folder named template under the 'reqs' folder and in that folder place your template files.

reqs/
├── REQ001.yml
├── REQ002.yml
├── <snip>
├── assets
│   └── logo-black-white.png
└── template
    ├── TEMPLATE_NAME.cls
    └── TEMPLATE_NAME.yml

Please note that you have to supply both a .cls file and a .yml file and that the --template flag takes the name without any file ending.

I hope this helps, and I will try to update the documentation as soon as possible.

Kind regards,
Gustav

from doorstop.

MarcelGep avatar MarcelGep commented on June 9, 2024

Hey @neerdoc
thanks for the response this way works 👍
With a correct documentation this will be perfect :-)

That means that i can add for each document folder a separate template folder and can using separate templates for each document?

├── swrs
│   ├── HEAD-1.0.yml
│   ├── HEAD-1.1.yml
│   ├── SWRS0001.yml
│   └── SWRS0002.yml
├── sys
│   ├── assets
│   │   └── autoware-logo.png
│   ├── HEAD-1.0.yml
│   ├── HEAD-1.1.yml
│   ├── HEAD-1.2.yml
│   ├── HEAD-1.3.yml
│   ├── SYS0001.yml
│   ├── SYS0002.yml
│   ├── SYS0003.yml
│   └── template
│       ├── logo-black-white.png
│       ├── template.cls
│       └── template.yml
└── template
    ├── logo-black-white.png
    ├── template.cls
    └── template.yml

from doorstop.

MarcelGep avatar MarcelGep commented on June 9, 2024

Ok if i put only the "template" folder into the "reqs" folder it doesn't work!

doorstop.common.DoorstopError: Template flag set, but no 'template' folder was found.

It only works if i put the "template" folder into the document folder "sys" -> "reqs/sys/template".

├── swrs
│   ├── HEAD-1.0.yml
│   ├── HEAD-1.1.yml
│   ├── SWRS0001.yml
│   └── SWRS0002.yml
└── sys
    ├── assets
    │   └── autoware-logo.png
    ├── HEAD-1.0.yml
    ├── HEAD-1.1.yml
    ├── HEAD-1.2.yml
    ├── HEAD-1.3.yml
    ├── SYS0001.yml
    ├── SYS0002.yml
    ├── SYS0003.yml
    └── template
        ├── logo-black-white.png
        ├── template.cls
        └── template.yml

from doorstop.

jacebrowning avatar jacebrowning commented on June 9, 2024

This beta release contains a fix for this issue: https://pypi.org/project/doorstop/3.0b11/ cc @neerdoc

from doorstop.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.