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

Docs fixes #217

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Docs fixes #217

wants to merge 7 commits into from

Conversation

Sebanisu
Copy link
Collaborator

@Sebanisu Sebanisu commented Apr 22, 2021 •
edited
Loading

resolves: #216

I'm taking some things I learned from adding docs on my repo and applying it to yours.

  • Unrelated I also added code to cmake to make it go git the submodule for me.
  • Add myst_parser, remove the preprocessor.py
    • I couldn't get this to work. myst_parser supports .md files.
  • GLOB_RECURSE more things. these are DEPENDS so that cmake knows to rerun sphinx or doxygen if these files change.
    • was just .h files
    • now checks .cpp, .c, .hpp
    • Also .rst and .md
  • doygen disable HTML and LATEX as sphinx only uses XML
  • set source_suffix so sphinx knows to check both .md and .rst files.
  • made a verbs.md and left verbs-old.rst so you could compare.
  • updated FindSphinx.cmake to make it more likely to find sphinx. pip installs it to your home folder on ubuntu. So I gave it some hints of places to look.

@Sebanisu
Update FindSphinx.cmake
b5a6db5 
added some code to make it better at finding sphinx. pip3 doesn't install things to the global bin folder. cmake is also checking for python3 and trying to use it.
@Sebanisu
added submodule code to cmake to check submodule before adding sub di…
116446a 
…rectory
@Sebanisu
Update CMakeLists.txt
5346a2b 
checking for more than just .h files

also globing md and rst files instead of only checking the index.

changed the __output__ to a variable. Though I want to remove this entirely as it doesn't work on my system.
@Sebanisu
Update CMakeLists.txt
519b9f0 
uncomment .md
@Sebanisu
Update Doxyfile.in
776aa14 
disable generating html and latex. because we only use xml with sphinx
@Sebanisu Sebanisu added bug Something isn't working documentation Improvements or additions to documentation labels Apr 22, 2021
@Sebanisu Sebanisu self-assigned this Apr 22, 2021
@Sebanisu
removed pre processor and added myst_parser
46d39d0 
I think this will be more reliable.

I also converted verbs.rst to verbs.md so you could compare.
@Sebanisu Sebanisu marked this pull request as ready for review April 22, 2021 21:24
@Sebanisu
Update verbs.md
78b7cd7 
having empty toctree's can have undesired behavior on some themes. They are meant to you to link to other doc pages from this one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codereport codereport Awaiting requested review from codereport codereport is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@Sebanisu Sebanisu

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

preprocessor.py shutil.copytree throws permission denied messages.
1 participant
@Sebanisu