Comments (5)
Which version of Codox are you using?
from codox.
0.6.6
project.clj is here: https://github.com/SnootyMonkey/Falkland-CMS/blob/master/project.clj
from codox.
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.
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.
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)
- boot-codox always output in some temporary directory HOT 1
- how do you document entire project (maybe put on Introduction html page?) HOT 1
- Crux and codox HOT 1
- Multiple projects that share the same root index.html HOT 3
- Document how to use with deps.edn HOT 5
- getting an error (0.10.7) HOT 2
- can't generate Clojurescript docs on re-frame template HOT 6
- codox crashes under Java 16 HOT 8
- Integrating Cloverage HOT 2
- In deps.edn projects, lookup qualified keywords in exec-args as aliases in basis HOT 4
- `:project` key in deps.edn is ignored. HOT 2
- CompilerException when macroexpanding an ns containing reader-condtional requires HOT 1
- How can I render the autogenerated codox docs as documentation in github ? HOT 2
- Could not transfer artifact com.vladsch.flexmark:flexmark-ext-emoji:jar:0.62.2
- Namespace trimming
- Cannot generate Source Links HOT 2
- Accept a basis for tools.build compatibility HOT 4
- jquery included in default theme has XSS vulnerability issue
- [Feature request] Support simultaneous Clojure & ClojureScript output HOT 7
- Regexes are not supported in EDN, and therefore not supported when Codox is used from tools.deps
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from codox.