Skip to content

Commit

Permalink
Docs: Use formatted cmd ref in pdf
Browse files Browse the repository at this point in the history
Fixes missing links in body and `??` in tag/command index.
Update synth.rst to match.
  • Loading branch information
KrystalDelusion committed May 13, 2024
1 parent 229300b commit ee53fa3
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 14 deletions.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ available, go to :ref:`commandindex`.
- Search bar with live drop down suggestions for matching on title /
autocompleting commands
- Scroll the left sidebar to the current location on page load
- Also the formatting/linking in pdf is broken
- Also the formatting in pdf uses link formatting instead of code formatting

.. todolist::

Expand Down
1 change: 0 additions & 1 deletion docs/source/using_yosys/synthesis/synth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ The following commands are executed by the :cmd:ref:`prep` command:

.. literalinclude:: /cmd/prep.rst
:start-at: begin:
:end-before: .. raw:: latex
:dedent:

:doc:`/getting_started/example_synth` covers most of these commands and what
Expand Down
12 changes: 0 additions & 12 deletions kernel/register.cc
Original file line number Diff line number Diff line change
Expand Up @@ -781,7 +781,6 @@ struct HelpPass : public Pass {
fprintf(f, "%s", title_line.c_str());
fprintf(f, "%s - %s\n", cmd.c_str(), title.c_str());
fprintf(f, "%s\n", title_line.c_str());
fprintf(f, ".. raw:: latex\n\n \\begin{comment}\n\n");

// render html
fprintf(f, ".. cmd:def:: %s\n", cmd.c_str());
Expand Down Expand Up @@ -851,17 +850,6 @@ struct HelpPass : public Pass {

blank_count = 0;
}
fputc('\n', f);

// render latex
fprintf(f, ".. raw:: latex\n\n \\end{comment}\n\n");
fprintf(f, ".. only:: latex\n\n");
fprintf(f, " ::\n\n");
std::stringstream ss2;
ss2 << textcp;
for (std::string line; std::getline(ss2, line, '\n');) {
fprintf(f, " %s\n", line.c_str());
}
fclose(f);
}
void execute(std::vector<std::string> args, RTLIL::Design*) override
Expand Down

0 comments on commit ee53fa3

Please sign in to comment.