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.

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

Adding separators after docstrings #12

Open
abogdanov85 opened this issue Mar 26, 2024 · 1 comment
Open

Adding separators after docstrings #12

abogdanov85 opened this issue Mar 26, 2024 · 1 comment

Comments

@abogdanov85
Copy link

I have this problem when using DocumenterMarkdown.

If we have a block of several docstrings like this:

```@docs
Base.Function1
Base.Function2
```
Some text outside of macro.

then in the output we will get something like this:

<a id='Base.Function1' href='#Base.Function1'>#</a>
**`Base.Function1`** &mdash; *Function*.

Docstring text for Function1

<a id='Base.Function2' href='#Base.Function2'>#</a>
**`Base.Function2`** &mdash; *Function*.

Docstring text for Function2

Some text outside of macro.

The problem is that we don't have any separator between the end of docstring text and the next text. Because of that it is difficult to further isolate the docstring texts on this page (if we want to convert it to some other format and maybe to make some highlighting for every separate docstring - for example add frames to them).

It would be great to have something like this in the output:

<a id='Base.Function1' href='#Base.Function1'>#</a>
**`Base.Function1`** &mdash; *Function*.

Docstring text for Function1

[//]: # (End of docstring)

<a id='Base.Function2' href='#Base.Function2'>#</a>
**`Base.Function2`** &mdash; *Function*.

Docstring text for Function2

[//]: # (End of docstring)

Some text outside of macro.

Or any other type of separators (horizontal line, some html tag etc.)

@asinghvi17
Copy link

Will be solved by #13

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants