Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move to ex_doc -style documentation #112

Merged
merged 13 commits into from
Nov 15, 2024
Merged

Move to ex_doc -style documentation #112

merged 13 commits into from
Nov 15, 2024

Commits on Jun 30, 2024

  1. Move doc/ out of the way (and .gitignore it) 

    It'll be online at hexdocs.pm
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    48a3048 View commit details
    Browse the repository at this point in the history

  2. Move to ex_doc

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    cd07791 View commit details
    Browse the repository at this point in the history

  3. Fix doc. generation issues 

    Also moves @doc to before -spec, where it's most commonly found
Also moves @hidden > @Private
Also moves @equiv to "Same as"
Also moves @link to `, since ExDoc does auto-reference
Also moves @see to `, for the same reason as @link
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    54311b1 View commit details
    Browse the repository at this point in the history

  4. Markdown -lint and tweak to rebar3_ex_doc's liking

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    0dae9da View commit details
    Browse the repository at this point in the history

  5. Update README as per current constraints

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    bde4da3 View commit details
    Browse the repository at this point in the history

  6. Move overview to its own .md 

    (and reference it from README.md)
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    164f23e View commit details
    Browse the repository at this point in the history

  7. Bump rebar3_ex_doc from 0.2.18 to 0.2.23

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    835199d View commit details
    Browse the repository at this point in the history

  8. Act on CI results: fix post-rebase issues

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jun 30, 2024
    Configuration menu
    Copy the full SHA
    019a147 View commit details
    Browse the repository at this point in the history

Commits on Jul 1, 2024

  1. Update README.md: proper link

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    fbc62a4 View commit details
    Browse the repository at this point in the history

  2. Keep generated docs in hexdocs.pm alone

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    8c4d730 View commit details
    Browse the repository at this point in the history

  3. CI: make sure doc generation isn't broken

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    8539c10 View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2024

  1. Revert back to what it was

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    f3646a2 View commit details
    Browse the repository at this point in the history

  2. Fix strange output on documentation 

    ex_doc is already smart enough to turn the call
into a link to the Erlang docs
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    828b981 View commit details
    Browse the repository at this point in the history