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

A lot of the files that are in docs are not included. Keep or obsolete? #444

Open
11 tasks
lsawade opened this issue Feb 3, 2025 · 0 comments
Open
11 tasks

Comments

@lsawade
Copy link
Collaborator

lsawade commented Feb 3, 2025

Check whether following docs are up-to-date, need updating, or deletion:

  • docs/api/datatypes/index/
  • `docs/api/datatypes/kernels/point.rst
  • `docs/api/datatypes/stress_integrands/index/rst
  • docs/benchmarks/benchmarks.rst
  • docs/developer_documentation/ a lot of files aren't being used here currently
  • docs/feature_request/index.rst
  • docs/getting_started/ only index.rst is used in this dir
  • docs/join_the_community/index.rst
  • docs/meshfem2d/receiver_documentation.rst
  • docs/parameter_documentation/seismogram_setup.rst def outdated
  • docs/report_bugs/index.rst

Current sphinx output:

``` /Users/lsawade/SPECFEMPP/docs/api/assembly/coupled_interfaces/coupled_interface.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/datatypes/index/assembly_index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/datatypes/index/simd_assembly_index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/datatypes/index/simd_index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/datatypes/kernels/point.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/datatypes/stress_integrands/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/boundaries/absorbing_boundaries.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/boundaries/acoustic_free_surface.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/boundaries/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/control_nodes/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/coupled_interfaces/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/materials/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/api/mesh/tags/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/benchmarks/benchmarks.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/SPECFEM_architecture/architecture.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/cmake_primer.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/doxygen_primer.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/kokkos_primer.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/tutorials/tutorial1/Chapter6/chunk_element_policy.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/tutorials/tutorial1/Chapter6/range_policy.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/tutorials/tutorial1/Chapter7/divergence.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/developer_documentation/tutorials/tutorial1/Chapter7/gradient.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/feature_request/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/getting_started/installation.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/getting_started/introduction.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/getting_started/requirements.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/join_the_community/index.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/meshfem2d/receiver_documentation.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/parameter_documentation/seismogram_setup.rst: WARNING: document isn't included in any toctree /Users/lsawade/SPECFEMPP/docs/report_bugs/index.rst: WARNING: document isn't included in any toctree ```
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

1 participant