Deploying to gh-pages from @ 30444b0 🚀

pr-preview/4875/repository_structure.html

@@ -134,6 +134,9 @@
   <li class="level1">
     <a href="#writing-documentation">Writing documentation</a>
     <ul>
+      <li class="level2">
+        <a href="#quick-guide-for-developing-the-doxygen-documentation">Quick guide for developing the Doxygen documentation</a>
+      </li>
       <li class="level2">
         <a href="#documentation-comments-style-guide">Documentation Comments Style Guide</a>
       </li>
@@ -263,6 +266,20 @@ <h1><a class="anchor" id="writing-documentation"></a>
 <p>Documentation is generated from two main sources: README files distributed across the repository and comments within the code. The README files are tagged with documentation inclusion notes to indicate their integration into the P4 compiler documentation.</p>
 <p>Code comments should capture the main intent of the implementation and the "why", rather than the "how". The how can be read from the code, however, documenting the reasons why a certain implementation was chosen will help other contributors understand the design choices and enable them to reuse your code. Also important in the context of the compiler is to document the invariants for each pass (or groups of passes), since it is likely that other developers will need to insert additional passes, and they should understand the effects that the pass ordering has on the AST.</p>
 <p>Documentation in the markup documents is intended for higher level design documentation. The files will be automatically captured in the documentation in the order implied by their naming: XX_my_doc.md where XX is a number between 02-99. Currently, 00_revision_history.md contains the documentation revision history, and 01_overview.md is the overview of the compiler goals and architecture.</p>
+<h2><a class="anchor" id="quick-guide-for-developing-the-doxygen-documentation"></a>
+Quick guide for developing the Doxygen documentation</h2>
+<ul>
+<li>Doxygen is configured in <code>docs/doxygen/doxygen.cfg</code>.</li>
+<li>The main HTML page is configured in <code>docs/doxygen/Doxymain.md</code>:<ul>
+<li>CSS for the card effect is in <code>docs/assets/css/card.css</code>.</li>
+<li>The effect for the Easter egg toggle is defined in <code>docs/assets/css/flow.css</code>.</li>
+<li>The homepage P4C architecture is rendered using <code>docs/assets/architecture_unanimated.html</code>, with the editable draw file available at <code>docs/assets/Architecture.drawio</code>.</li>
+</ul>
+</li>
+<li>Add pages and subpages manually to the sidebar (see <code>docs/doxygen/p4c_layout.xml</code>).</li>
+<li>TOCs in markdown files are created with the <code>[TOC]</code> command.</li>
+<li>The base style for Doxygen Awesome is described in the <a href="https://jothepro.github.io/doxygen-awesome-css/">Doxygen Awesome Documentation</a> and the updated color scheme is defined in <a href="https://github.com/p4lang/p4c/blob/main/docs/assets/css/p4c_custom.css"><code>docs\assets\css\p4c_custom.css</code></a>.</li>
+</ul>
 <h2><a class="anchor" id="documentation-comments-style-guide"></a>
 Documentation Comments Style Guide</h2>
 <ul>

pr-preview/4875/search/all_21.js

@@ -1,4 +1,13 @@
 var searchData=
 [
-  ['yylloc_0',['yylloc',['../class_p4_1_1_abstract_parser_driver.html#a24ade0995b31810ca08459b6966147e1',1,'P4::AbstractParserDriver']]]
+  ['xdp_20based_20design_0',['XDP-based design',['../ebpf_backend.html#xdp-based-design',1,'']]],
+  ['xdp2tc_20mode_1',['XDP2TC mode',['../ebpf_backend.html#xdp2tc-mode',1,'']]],
+  ['xdp_5fmodel_2',['Xdp_Model',['../struct_p4_1_1_e_b_p_f_1_1_xdp___model.html',1,'P4::EBPF']]],
+  ['xdpegressdeparserpsa_3',['XDPEgressDeparserPSA',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_egress_deparser_p_s_a.html',1,'P4::EBPF']]],
+  ['xdpegresspipeline_4',['XDPEgressPipeline',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_egress_pipeline.html',1,'P4::EBPF']]],
+  ['xdphelpprogram_5',['XDPHelpProgram',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_help_program.html',1,'P4::EBPF']]],
+  ['xdpingressdeparserpsa_6',['XDPIngressDeparserPSA',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_ingress_deparser_p_s_a.html',1,'P4::EBPF']]],
+  ['xdpingresspipeline_7',['XDPIngressPipeline',['../class_p4_1_1_e_b_p_f_1_1_x_d_p_ingress_pipeline.html',1,'P4::EBPF']]],
+  ['xdptarget_8',['XdpTarget',['../class_p4_1_1_e_b_p_f_1_1_xdp_target.html',1,'P4::EBPF']]],
+  ['xor16_9',['xor16',['../namespace_p4_1_1_net_hash.html#aaffa89e4bd87fba4761506c9133df39f',1,'P4::NetHash']]]
 ];

pr-preview/4875/search/all_22.js

@@ -1,41 +1,4 @@
 var searchData=
 [
-  ['z3declaredvariablesmap_0',['Z3DeclaredVariablesMap',['../namespace_p4_1_1_p4_tools.html#a00301b84e5252bf2ec7c669d5363c67c',1,'P4::P4Tools']]],
-  ['z3solver_1',['Z3Solver',['../class_p4_1_1_p4_tools_1_1_z3_solver.html',1,'P4::P4Tools']]],
-  ['z3solveraccessor_2',['Z3SolverAccessor',['../class_p4_1_1_p4_tools_1_1_z3_solver_accessor.html',1,'P4::P4Tools::Z3SolverAccessor'],['../class_p4_1_1_p4_tools_1_1_z3_solver_accessor.html#aad67aa50f0b1cda205a6c653d5db551a',1,'P4::P4Tools::Z3SolverAccessor::Z3SolverAccessor()']]],
-  ['z3solveradd_3',['Z3SolverAdd',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_add.html',1,'P4::Test::Z3Test']]],
-  ['z3solveraddsat01_4',['Z3SolverAddSat01',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_add_sat01.html',1,'P4::Test::ArithmTest']]],
-  ['z3solveraddsat02_5',['Z3SolverAddSat02',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_add_sat02.html',1,'P4::Test::ArithmTest']]],
-  ['z3solveraddsat03_6',['Z3SolverAddSat03',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_add_sat03.html',1,'P4::Test::ArithmTest']]],
-  ['z3solveraddsat04_7',['Z3SolverAddSat04',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_add_sat04.html',1,'P4::Test::ArithmTest']]],
-  ['z3solveraddsat05_8',['Z3SolverAddSat05',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_add_sat05.html',1,'P4::Test::ArithmTest']]],
-  ['z3solverband_9',['Z3SolverBAnd',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_b_and.html',1,'P4::Test::Z3Test']]],
-  ['z3solverbor_10',['Z3SolverBOR',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_b_o_r.html',1,'P4::Test::Z3Test']]],
-  ['z3solverbxor_11',['Z3SolverBXor',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_b_xor.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercastbit2bool_12',['Z3SolverCastBit2Bool',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_cast_bit2_bool.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercastbit2equalbit_13',['Z3SolverCastBit2EqualBit',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_cast_bit2_equal_bit.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercastbit2largerbit_14',['Z3SolverCastBit2LargerBit',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_cast_bit2_larger_bit.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercastbit2lessbit_15',['Z3SolverCastBit2LessBit',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_cast_bit2_less_bit.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercastbool2bit_16',['Z3SolverCastBool2Bit',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_cast_bool2_bit.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercastinassignment_17',['Z3SolverCastInAssignment',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_cast_in_assignment.html',1,'P4::Test::Z3Test']]],
-  ['z3solvercomplement_18',['Z3SolverComplement',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_complement.html',1,'P4::Test::Z3Test']]],
-  ['z3solverconc_19',['Z3SolverConc',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_conc.html',1,'P4::Test::Z3Test']]],
-  ['z3solverite_20',['Z3SolverITE',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_i_t_e.html',1,'P4::Test::Z3Test']]],
-  ['z3solvermod_21',['Z3SolverMod',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_mod.html',1,'P4::Test::Z3Test']]],
-  ['z3solvermult_22',['Z3SolverMult',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_mult.html',1,'P4::Test::Z3Test']]],
-  ['z3solversatisfiabilitychecks_23',['Z3SolverSatisfiabilityChecks',['../class_p4_1_1_test_1_1_z3_solver_satisfiability_checks.html',1,'P4::Test']]],
-  ['z3solversattests_24',['Z3SolverSatTests',['../class_p4_1_1_test_1_1_z3_solver_sat_tests.html',1,'P4::Test']]],
-  ['z3solvershl_25',['Z3SolverShl',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_shl.html',1,'P4::Test::Z3Test']]],
-  ['z3solvershrs_26',['Z3SolverShrS',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_shr_s.html',1,'P4::Test::Z3Test']]],
-  ['z3solvershru_27',['Z3SolverShrU',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_shr_u.html',1,'P4::Test::Z3Test']]],
-  ['z3solversub_28',['Z3SolverSub',['../class_p4_1_1_test_1_1_z3_test_1_1_z3_solver_sub.html',1,'P4::Test::Z3Test']]],
-  ['z3solversubsat01_29',['Z3SolverSubSat01',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_sub_sat01.html',1,'P4::Test::ArithmTest']]],
-  ['z3solversubsat02_30',['Z3SolverSubSat02',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_sub_sat02.html',1,'P4::Test::ArithmTest']]],
-  ['z3solversubsat03_31',['Z3SolverSubSat03',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_sub_sat03.html',1,'P4::Test::ArithmTest']]],
-  ['z3solversubsat04_32',['Z3SolverSubSat04',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_sub_sat04.html',1,'P4::Test::ArithmTest']]],
-  ['z3solversubsat05_33',['Z3SolverSubSat05',['../class_p4_1_1_test_1_1_arithm_test_1_1_z3_solver_sub_sat05.html',1,'P4::Test::ArithmTest']]],
-  ['z3solvertest_34',['Z3SolverTest',['../class_p4_1_1_test_1_1_z3_solver_test.html',1,'P4::Test']]],
-  ['z3solvertests_35',['Z3SolverTests',['../class_p4_1_1_test_1_1_z3_solver_tests.html',1,'P4::Test']]],
-  ['z3translator_36',['Z3Translator',['../class_p4_1_1_p4_tools_1_1_z3_translator.html',1,'P4::P4Tools::Z3Translator'],['../class_p4_1_1_p4_tools_1_1_z3_translator.html#a0f67d60efc13200ae7089ef0ba146343',1,'P4::P4Tools::Z3Translator::Z3Translator()']]],
-  ['zerotomax_37',['ZeroToMax',['../struct_p4_1_1_bit_range_1_1_zero_to_max.html',1,'P4::BitRange']]]
+  ['yylloc_0',['yylloc',['../class_p4_1_1_abstract_parser_driver.html#a24ade0995b31810ca08459b6966147e1',1,'P4::AbstractParserDriver']]]
 ];