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

Figure out how to skip copyright header in verilog output in rendered Sphinx docs #47

Closed
mithro opened this issue Apr 16, 2020 · 5 comments · Fixed by SymbiFlow/sphinxcontrib-hdl-diagrams#20
Closed

Figure out how to skip copyright header in verilog output in rendered Sphinx docs #47

mithro opened this issue Apr 16, 2020 · 5 comments · Fixed by SymbiFlow/sphinxcontrib-hdl-diagrams#20
Assignees
@daniellimws

Comments

@mithro
Copy link
Collaborator

mithro commented Apr 16, 2020 •
edited

It would be nice to automatically skip the copyright header when displaying the verilog output into the Sphinx documentation.

Currently a verilog file like this;

/*
 * Copyright (C) 2020  The SymbiFlow Authors.
 *
 * Use of this source code is governed by a ISC-style
 * license that can be found in the LICENSE file or at
 * https://opensource.org/licenses/ISC
 *
 * SPDX-License-Identifier:	ISC
 */

/*
 * `input wire a` should be detected as a clock because of the `(* CLOCK *)`
 * attribute.
 */
(* whitebox *)
module BLOCK(a, b, o);
	(* CLOCK *)
	input wire a;
	input wire b;
	output wire o;
endmodule

You end up with the output which looks like this;
Screenshot from 2020-04-16 10-42-23

This is probably an issue + test needed in https://github.com/SymbiFlow/sphinxcontrib-verilog-diagrams
@daniellimws
Copy link
Collaborator

I managed to hide it with the :start-after: option of literalinclude as seen in 646d3d2.

@daniellimws daniellimws mentioned this issue Apr 19, 2020
Merged
@mithro
Copy link
Collaborator Author

mithro commented Apr 23, 2020 •
edited by unfurl-links bot

@daniellimws - It would be nice if there was a literalinclude like directive that automatically detected the copyright header in the file and added the :start-after: bit automatically. This could probably be done via a similar manner to https://github.com/mithro/sphinxcontrib-session

GitHub
Sphinx extension for displaying console and other sessions. - mithro/sphinxcontrib-session

@daniellimws
Copy link
Collaborator

daniellimws commented Apr 23, 2020 •
edited by unfurl-links bot

@mithro Where would be a good place to implement this directive? Shall I add this feature into https://github.com/mithro/sphinxcontrib-session?

GitHub
Sphinx extension for displaying console and other sessions. - mithro/sphinxcontrib-session

@mithro
Copy link
Collaborator Author

mithro commented Apr 23, 2020

@daniellimws I think as part of sphinxcontrib-verilog-diagrams probably makes some sense? Otherwise maybe we need a new sphinxcontrib-fancyinclude type project?

@daniellimws
Copy link
Collaborator

Alright sounds good, I'll add it to sphinxcontrib-verilog-diagrams.

@daniellimws daniellimws mentioned this issue Apr 25, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@daniellimws daniellimws

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Directive to include code without license header daniellimws/sphinxcontrib-verilog-diagrams
2 participants
@mithro @daniellimws