Coder Social home page Coder Social logo

Comments (5)

weavejester avatar weavejester commented on August 18, 2024

Which version of Codox are you using?

from codox.

belucid avatar belucid commented on August 18, 2024

0.6.6

project.clj is here: https://github.com/SnootyMonkey/Falkland-CMS/blob/master/project.clj

from codox.

belucid avatar belucid commented on August 18, 2024

FWIW, I also tried it with 0.6.4, which was what hiccup is using, since I noticed their source links looked fine. I got the same result with 0.6.4.

from codox.

weavejester avatar weavejester commented on August 18, 2024

I took a closer look at your project.clj file. You've entered the wrong source path in your Codox setup. Rather than ["src"] or just leaving it blank, you've put in ["src/fcms/resources"] instead. Because it's a subdirectory of your source folder, Codox isn't able to resolve the paths.

Ideally this should raise an exception, but I don't think anyone's triggered this before.

from codox.

belucid avatar belucid commented on August 18, 2024

Thanks! You're right, that worked just fine with this conf:

  :codox {
    :include [fcms.resources.common fcms.resources.collection fcms.resources.item fcms.resources.taxonomy]
    :output-dir "../Falkland-CMS-docs/API/Clojure"
    :src-dir-uri "http://github.com/SnootyMonkey/Falkland-CMS/blob/master/"
    :src-linenum-anchor-prefix "L" ; for Github
  }

I thought I'd discovered a nifty feature by setting sources to "src/fcms/resources" I was able to specify that I wanted docs for just that dir and didn't need each namespace individually.

With that config, I didn't need to worry about forgetting to add it to codox when I added a namespace. It effectively let me scope the docs to all the namespaces in the dir.

Such a config would be desirable :-)

from codox.

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.