0ad/0ad
0ad/0ad
11
9
Fork 21
Code Issues 1.5k Pull Requests 36 Actions Projects Releases Wiki Activity

doxygen-improvement (D5252) #7052

Open
Cayleb-Ordo wants to merge 4 commits from Cayleb-Ordo/0ad:doxygen-improvement into main
pull from: Cayleb-Ordo/0ad:doxygen-improvement
merge into: 0ad:main
Conversation 12 Commits 4 Files Changed 13 +259 -176
Cayleb-Ordo commented 2024-09-16 22:21:37 +02:00
First-time contributor
Copy Link

I thought ill try the new system with this change, so it wont get lost.

I thought ill try the new system with this change, so it wont get lost.
Cayleb-Ordo added 3 commits 2024-09-16 22:21:40 +02:00 
Switched to CMake for configuring and building the doxygen Website.
Set the minimum requirements to CMake >=3.18.4 and Doxygen >=1.9.1.
Add a new Dockerfile which uses debian:trixie-slim instead of debian:buster as base.
Set the used Rust version to 1.51.0.
Modify Jenkins Pipeline to use the new Dockerfile.
docs: Add a custom style to the doxygen website based on the docs webpage
Some checks failed
0ad-freebsd/pipeline/pr-main This commit looks good
Details
0ad-windows/pipeline/pr-main This commit looks good
Details
0ad-linux/pipeline/pr-main This commit looks good
Details
0ad-macos/pipeline/pr-main This commit looks good
Details
checkrefs / checkrefs (pull_request) Successful in 1m4s
Details
pre-commit / build (pull_request) Failing after 1m23s
Details
f7812a7c9c
Cayleb-Ordo requested review from Itms 2024-09-16 22:21:40 +02:00
Cayleb-Ordo requested review from Stan 2024-09-16 22:21:40 +02:00
Itms commented 2024-09-16 23:32:18 +02:00
Owner
Copy Link

Thanks for the port to here! I will use the opportunity to setup the docs pipeline.

Thanks for the port to here! I will use the opportunity to setup the docs pipeline.
Itms self-assigned this 2024-09-16 23:32:24 +02:00
Stan commented 2024-09-17 10:16:31 +02:00
Owner
Copy Link

Thanks indeed for the follow up. Unfortunately the friend I asked for the logo update hasn't delivered yet. I suppose the first version will use the logo you found.

Thanks indeed for the follow up. Unfortunately the friend I asked for the logo update hasn't delivered yet. I suppose the first version will use the logo you found.
Itms commented 2024-09-17 17:13:14 +02:00
Owner
Copy Link

Would you be interested in this logo found in the art repo ?

Would you be interested in this logo found in the art repo ?
pyrogenesislogo.png
28 KiB
pyrogenesislogo.png
Cayleb-Ordo commented 2024-09-17 23:17:19 +02:00
Author
First-time contributor
Copy Link

The Logo itself looks good. But then we have to review the current Style i have set. For Example the right one is the current style. The other one could also be used. I personally favor the one with the red header, as the technical docs website uses the same look and feel.

The Logo itself looks good. But then we have to review the current Style i have set. For Example the right one is the current style. The other one could also be used. I personally favor the one with the red header, as the technical docs website uses the same look and feel.
docs-red-header.png
96 KiB
docs-red.png
91 KiB
docs-red-header.png docs-red.png
Cayleb-Ordo force-pushed doxygen-improvement from f7812a7c9c to ab93b8e9ab 2024-09-17 23:27:54 +02:00 Compare
Itms requested changes 2024-09-25 13:52:48 +02:00
Itms left a comment
Owner
Copy Link

Hello! I have setup a rough pipeline for generating the docs. I ran it, including the upload to the website.

Can you please adapt your work and rebase it on top of Itms/docs? Then I will set the pipeline to follow your PR instead of my branch.

Thanks for your work.

Hello! I have setup a rough pipeline for generating the docs. I ran it, including the upload to the website. Can you please adapt your work and rebase it on top of [Itms/docs](https://gitea.wildfiregames.com/Itms/0ad/src/branch/docs)? Then I will set the pipeline to follow your PR instead of my branch. Thanks for your work.
LICENSE.md Outdated
@ -0,0 +1,104 @@
# 0 A.D. Licensing Details
Itms commented 2024-09-17 17:20:39 +02:00
Owner
Copy Link

Can you also delete LICENSE.txt so that this becomes a file move?

Can you also delete LICENSE.txt so that this becomes a file move?
Cayleb-Ordo marked this conversation as resolved
build/jenkins/dockerfiles/gcc13-docs.Dockerfile Outdated
@ -0,0 +1,50 @@
FROM debian:trixie-slim
Itms commented 2024-09-17 17:23:39 +02:00
Owner
Copy Link

I have reduced this to a dockerfile where only documentation tools are installed. This documentation pipeline should not need building the game. The entity.rng file will be generated in the nightly build.

I have reduced this to a dockerfile where only documentation tools are installed. This documentation pipeline should not need building the game. The entity.rng file will be generated in the nightly build.
Cayleb-Ordo commented 2024-09-26 23:49:52 +02:00
Author
First-time contributor
Copy Link

I removed my ggc13-docs Dockerfile.

I removed my ggc13-docs Dockerfile.
Cayleb-Ordo marked this conversation as resolved
docs/doxygen/CMakeLists.txt Outdated
@ -0,0 +18,4 @@
# Get current Branch Name to set it as the Project Number.
find_package(Git)
find_package(Subversion)
Itms commented 2024-09-25 13:42:04 +02:00
Owner
Copy Link

This pipeline will run on a git checkout, not an SVN checkout, you can remove SVN dependent code.

This pipeline will run on a git checkout, not an SVN checkout, you can remove SVN dependent code.
Cayleb-Ordo commented 2024-09-26 22:36:42 +02:00
Author
First-time contributor
Copy Link

Alright, ill remove that.

Alright, ill remove that.
Cayleb-Ordo marked this conversation as resolved
Stan commented 2024-09-25 15:42:35 +02:00
Owner
Copy Link

@Itms using debian-latest doesn't seem really reproductible. Not sure it matters much though? Python versions maybe?

@Itms using debian-latest doesn't seem really reproductible. Not sure it matters much though? Python versions maybe?
Itms commented 2024-09-25 16:33:04 +02:00
Owner
Copy Link

@Itms using debian-latest doesn't seem really reproductible. Not sure it matters much though? Python versions maybe?

debian:bookworm would not be reproducible either, as that image gets updated regularly (at least on each point version). I'd like this pipeline to use trixie as soon as it's out. The only downside I'd see is if a package changes name or gets deleted between the versions, but that doesn't seem to be the case for the packages used here.

> @Itms using debian-latest doesn't seem really reproductible. Not sure it matters much though? Python versions maybe? `debian:bookworm` would not be reproducible either, as that image gets updated regularly (at least on each point version). I'd like this pipeline to use trixie as soon as it's out. The only downside I'd see is if a package changes name or gets deleted between the versions, but that doesn't seem to be the case for the packages used here.
Cayleb-Ordo force-pushed doxygen-improvement from ab93b8e9ab to 19e4e1ffa2 2024-09-26 23:40:18 +02:00 Compare
Cayleb-Ordo force-pushed doxygen-improvement from 19e4e1ffa2 to 0928487abf 2024-09-26 23:47:01 +02:00 Compare
Cayleb-Ordo force-pushed doxygen-improvement from 0928487abf to 6e8f476ef7 2024-09-27 00:00:02 +02:00 Compare
Cayleb-Ordo force-pushed doxygen-improvement from 6e8f476ef7 to a76c59e4a2 2024-09-27 00:12:16 +02:00 Compare
Cayleb-Ordo force-pushed doxygen-improvement from a76c59e4a2 to 8bf029ae31 2024-09-27 00:16:36 +02:00 Compare
Stan commented 2024-10-08 16:07:30 +02:00
Owner
Copy Link

@Itms Anything else needed here ?

@Itms Anything else needed here ?
Itms commented 2024-10-08 17:56:11 +02:00
Owner
Copy Link

@Itms Anything else needed here ?

Yes, a couple:

  • I had not performed the change of tracked branch on Jenkins. I just did so, and started a generation.
  • I do not know how much of the LFS files are needed, I haven't tested. Probably needs some trial and error.
  • I would have your opinion on the change I made in entity docs generation, where I changed the address from trunk.html to nightly.html. It is more correct but will break many links.
> @Itms Anything else needed here ? Yes, a couple: - [x] I had not performed the change of tracked branch on Jenkins. I just did so, and started a generation. - [ ] I do not know how much of the LFS files are needed, I haven't tested. Probably needs some trial and error. - [ ] I would have your opinion on the change I made in entity docs generation, where I changed the address from `trunk.html` to `nightly.html`. It is more correct but will break many links.
Stan commented 2024-10-09 14:10:48 +02:00
Owner
Copy Link

For 2) I would assume only the files in that doxygen folder, since as far as I know source in C++ doesn't have images.
For 3) I'm not sure the name of the html file matters, for https://docs.wildfiregames.com/pyrogenesis/ works ?

For 2) I would assume only the files in that doxygen folder, since as far as I know source in C++ doesn't have images. For 3) I'm not sure the name of the html file matters, for https://docs.wildfiregames.com/pyrogenesis/ works ?
Cayleb-Ordo commented 2024-10-09 20:25:02 +02:00
Author
First-time contributor
Copy Link

For 2) i can say that the docs only need the files located under /source. See CMakeLists.txt Line 59.
But i`d like to add another point. We did not finish the discussion on the style/Logo. This could be done in a later commit, but i think that this will not be touched in a long time after we merge that.

For 2) i can say that the docs only need the files located under /source. See CMakeLists.txt Line 59. But i`d like to add another point. We did not finish the discussion on the style/Logo. This could be done in a later commit, but i think that this will not be touched in a long time after we merge that.
Stan commented 2024-10-10 10:59:50 +02:00
Owner
Copy Link

I'm still working with someone for the logo, it will also require approval, so I think we can use the icon Itms provided. I'll make another PR with the updated art. (Will also be a good test for this pipeline) :)

I'm still working with someone for the logo, it will also require approval, so I think we can use the icon Itms provided. I'll make another PR with the updated art. (Will also be a good test for this pipeline) :)
Cayleb-Ordo commented 2024-10-10 18:42:32 +02:00
Author
First-time contributor
Copy Link

I'm still working with someone for the logo, it will also require approval, so I think we can use the icon Itms provided. I'll make another PR with the updated art. (Will also be a good test for this pipeline) :)

Currently the old logo is configured. If we will change the logo, then we could leave that because with the current style @Itms Logo is kind of invisible :D

> I'm still working with someone for the logo, it will also require approval, so I think we can use the icon Itms provided. I'll make another PR with the updated art. (Will also be a good test for this pipeline) :) Currently the old logo is configured. If we will change the logo, then we could leave that because with the current style @Itms Logo is kind of invisible :D
Some checks reported warnings
0ad-freebsd/pipeline/pr-main This commit looks good
Required
Details
checkrefs / checkrefs (pull_request) Successful in 47s
Required
Details
pre-commit / build (pull_request) Successful in 1m2s
Required
Details
0ad-linux/pipeline/pr-main This commit looks good
Required
Details
0ad-windows/pipeline/pr-main This commit looks good
Required
Details
0ad-macos/pipeline/pr-main This commit is unstable
Required
Details
This pull request has changes requested by an official reviewer.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u doxygen-improvement:Cayleb-Ordo-doxygen-improvement
git checkout Cayleb-Ordo-doxygen-improvement
Sign in to join this conversation.
Reviewers
No reviewers
Stan
Itms
Labels
Clear labels   
Closed
Duplicate

  
Closed
Fixed

  
Closed
Invalid

  
Closed
Needs info

  
Closed
Won't fix

  
Closed
Works for me

  
Difficulty
Hard

  
Difficulty
Medium

  
Difficulty
Simple

  
Needed for Beta

   
Needs Design Input

   
Needs Info

   
Pathfinding
  
Priority
1: Release Blocker

  
Priority
2: Must Have

  
Priority
3: Should Have

  
Priority
4: Nice To Have

  
Priority
5: If Time Permits

  
Regression
  
Theme
AI

  
Theme
Art & Animation

  
Theme
Atlas editor

  
Theme
Build & Packages

  
Theme
Core engine

  
Theme
Documentation

  
Theme
Internationalization & Localization

  
Theme
Maps

  
Theme
Multiplayer Lobby

  
Theme
Music & Sound FX

  
Theme
Network

  
Theme
Non-game systems

  
Theme
Simulation

  
Theme
UI & Simulation

  
Theme
UI – Game setup

  
Theme
UI – In-game

  
Theme
UI – Miscellaneous

  
Theme
Website & Forum

  
Type
Defect

  
Type
Enhancement

  
Type
Task

No Label
Closed
Duplicate
Closed
Fixed
Closed
Invalid
Closed
Needs info
Closed
Won't fix
Closed
Works for me
Difficulty
Hard
Difficulty
Medium
Difficulty
Simple
Needed for Beta
Needs Design Input
Needs Info
Pathfinding
Priority
1: Release Blocker
Priority
2: Must Have
Priority
3: Should Have
Priority
4: Nice To Have
Priority
5: If Time Permits
Regression
Theme
AI
Theme
Art & Animation
Theme
Atlas editor
Theme
Build & Packages
Theme
Core engine
Theme
Documentation
Theme
Internationalization & Localization
Theme
Maps
Theme
Multiplayer Lobby
Theme
Music & Sound FX
Theme
Network
Theme
Non-game systems
Theme
Simulation
Theme
UI & Simulation
Theme
UI – Game setup
Theme
UI – In-game
Theme
UI – Miscellaneous
Theme
Website & Forum
Type
Defect
Type
Enhancement
Type
Task
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
Itms
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: 0ad/0ad#7052
No description provided.
Delete Branch "Cayleb-Ordo/0ad:doxygen-improvement"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?