Giter Site home page Giter Site logo

Comments (3)

jimporter avatar jimporter commented on June 2, 2024

Sorry, no that's not possible. There shouldn't be any need to do that though (and in fact it could add stray files to your docs easily if you're not careful). What are you trying to accomplish?

from mike.

andboss avatar andboss commented on June 2, 2024

Sorry, no that's not possible. There shouldn't be any need to do that though (and in fact it could add stray files to your docs easily if you're not careful). What are you trying to accomplish?

ok, thanks for the clarification! I'm trying to support artifacts that are already located in the same folder (that was cleaned before), e.g.:

  • build step before with some external docs gen, e.g.:
    • doxygen --> generates HTML stuff to doxygen/html
    • rm -rf public/
    • mkdir -p public/doxygen
    • mv doxygen/html/* public/doxygen
  • poetry run mkdocs build ... --dirty --> cleans up public and therefore some references to public/doxygen are not valid

wanted to keep same now for multi-versioning with mike, but the public folder is cleaned up and do not want to copy doxygen stuff after mike call as need to make sure the doxygen html can be referenced by md files and has to be there before...

I know the doxygen integration solution is simple and can be done may be better with some mkdocs plugin, but need first to investigate such plugin, may be you have some recommendation...

from mike.

jimporter avatar jimporter commented on June 2, 2024

I think a plugin is the best solution for this, but I think it should also work just fine to add your generated Doxygen docs to your MkDocs source directory (docs/doxygen or something). MkDocs should automatically include all the files for you when building.

from mike.

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.