-
Notifications
You must be signed in to change notification settings - Fork 487
Closed
Labels
Description
Ahoy!
I am trying out the 4.0.0-beta
version of documentationjs and am having trouble getting good results. To try things out, I grabbed the /test/fixture/polyglot/blend.cpp
file and ran the following command locally
documentation build src/*.cpp --polyglot -f json -o documentation/ --name Test
The resulting index.html
file looks like this:
<!doctype html>
<html>
<head>
<meta charset='utf-8' />
<title>Test | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
<link href='assets/style.css' type='text/css' rel='stylesheet' />
<link href='assets/github.css' type='text/css' rel='stylesheet' />
</head>
<body class='documentation'>
<div class='container'>
<div class='clearfix md-mxn2'>
<div class='fixed md-show fix-3 overflow-auto max-height-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>Test</h3>
<div class='mb1'><code></code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block field'
type='text' />
<div id='toc'>
</div>
</div>
</div>
<div class='fix-margin-3'>
<div class='px2'>
</div>
</div>
</div>
</div>
<script src='assets/anchor.js'></script>
<script src='assets/site.js'></script>
</body>
</html>
Some extra attempts:
- When running
documentation lint src/*.cpp
nothing shows up. - Trying
documentation build src-test/*.cpp --polyglot -f md > documentation-test/API.md
results in an empty markdown file - Same for
documentation build src-test/*.cpp --polyglot -f json > documentation-test/test.json
, results in an empty array[]
Not exactly sure how to debug from here. Any help forward would be great!