lfe-rebar3/lodox

Like Codox for LFE.

lodox's Issues

Give Eric push rights

Username: @yurrriq

Compile includes and parse their LDoc chunks

Prepend something like:

(defmodule {{filename}}
  (export all)
  (export-macro all)) ; may have to parse forms for this

and pass '[return binary] to lfe_comp:file/2. See bin/lfedoc for more tricks.

Fix Hex issues

😢

Add a JSON writer

See quasiquoting#31.

Document all the things

See quasiquoting#37.

Combine apps in umbrella projects

In projects that have more than one app, e.g. /apps/*, we should generate a monolithic doc set, at least optionally. This would also require a configurable top-level output-path. (We have that already)

Discuss HTML template

Previously, we were generating HTML very similar to the output of Codox, but with the EDoc rewrite, we have an opportunity to change that. Does anyone have any suggestions or examples of HTML docs they prefer?

Update team with write permissions

Hey @oubiwann, the Lodox team only has read permissions on this repo. Can you fix it?

Add CONTRIBUTING.md

It would be great to get more people involved and we ought to have a little description of how that should go.

Rename provider to rebar3_lfe_lodox to follow suit

Fix wikilinks with special characters

I have a fix for this in my fork and am just opening the issue so I can close it.

Generate docs from Erlang source

Using the EDoc format internally, we could render docs from Erlang source.

Related:

• Use EDoc format internally (#30)
• OLP releases (lfe/olp#1)

Rethink links

With the changes proposed in #31, we'll have to jump through additional hoops to get Wikilinks handled correctly. Perhaps it would be better to adopt the {@link ...} convention. Same goes for `code` vs `code'. Perhaps we can take some cues from edown wrt rendering and {in,ex}ternal link resolution. Edown may help inform the solution to #16 as well.

Write tests

Over the course of development, a number of weird bugs have popped up, especially wrt HTML output. We should have tests to catch them.

Add lodox_writer behaviour

Handle macro-generated functions

Now that macros are getting more meta, we should probably somehow parse defuns that are generated by macros at compile time. @rvirding, could you remind me of the option to pass to the compiler to return the macro expanded forms?

Suggest lodox under project_plugins

Update the README: s/plugins/project_plugins.

See quasiquoting#60.

Consider storing parsed LDoc chunks in (a) file(s)

This could speed up subsequent runs. We can check the last modified dates to see if we need to parse again.

Add a Markdown writer à la lfe/doc/src

Update README to suggest Hex dependency

Use EDoc format internally

Right now we use a custom internal state based heavily on lfe_doc_v1 records. It might be worthwhile to adopt the EDoc record format.

Related:

• OLP releases (lfe/olp#1)
• Generate docs from Erlang source (#31)

is this dead?

Is this not maintained anymore? It doesn't work with any new version of lfe. (e.g. lfe 1.3)

Migrate issues from quasiquoting repo

https://github.com/quasiquoting/lodox/issues

Add a plaintext writer à la lfe/bin/lfedoc

Ensure built libs are copied to doc profile

as in rebar3_run

Port topics from Codox

See quasiquoting#48.

Support and document excluding modules

See quasiquoting#42.

• Support
• Document

Use proplists instead of maps

This will enable support for older OTP releases. Now that the hard work is done by lfe_doc, this should be no big deal.

• Replace maps with proplists
• Fix tests (specifically 17.1)
• Update docstrings
• Update README.md
• Update .travis.yml

Update Hex metadata

s/Homepage/GitHub/

Ensure README is up to date

See quasiquoting#40.

Merge from quasiquoting

Next time we get a stable release.