코딩일지(2024-06-06)

rx003 문서화작업을 진행중이다.

지금 새벽2시.. 박성호교수님께서 부탁하신 문서화작업을 진행중이다. 정확히는 통합 회고록?같은 것을 작성중이다.

이에 대한 코딩일지를 작성하는 이유는 나중에 내가 또 스핑크스로 작업할일이 많을 것이기 때문이다.

매도 먼저 맞는 게 낮다.

라는 속담이 있듯이, 지금 이렇게 삽질을 해놔야 나중에 더 바빠질때 삽질하느라 시간을 쏟으면서 맘고생하는 참사를 막을 수가 있다.

지금 내가 이렇게 스핑크스랑 rst문법에 대해 숙지하고 있으면, 나중에 donkeybro 문서랑 turtlebro문서에 대해서 조금 더 수월하게 작업을 할 수 있을 것 같다.

(그러면 정말 좋겠다….)

자 그럼 시작!

현재 rx003의 진척상황

현재 위 사진과 같이 목차를 설계해놓았다. 여기서 제일 중요한 것은 “Technical Reports”이다.

여기에 자율주행 대회 나갔던 것에 대한 내용들이 정리되어 있기 때문이다. 나중에 해당 보고서를 참고하여 polygon프로젝트에 재배포를 진행할 예정이다.

내가 지금까지 작업한 바로는 왼쪽에 있는 Home, News등이 모두 하나의 큰제목(h1)이라고 이해하는게 맞을 것 같다. 왜냐하면 Appendix에 들어가보면,

위와 같이 basic, basic2가 있으면 basic에 대한 폴더와 basic2에 대한 폴더가 나누어져 있는 것이 아니라, 이렇게 그냥 아래쪽에 붙어있는 꼴이다.

단순히 페이지의 개수는 큰제목의 개수와 일치한다는 것을 이해하자!

현재 Home부터 시작해서 Appendix까지 총 8개의 큰제목이 있으니 페이지의 개수는 8개라고 보는 것이 맞다.

그리고 basic,basic2는 각각 부제목(h2)정도로 이해하는게 맞을 것 같다.

만약 위와 같이 “*****“위에 제목을 주석처리해서 없애버리면은 아래와 같이

부제목이 사라지는 것을 알수가 있다.(즉 지금 내가 주석처리한 부분이 부제목의 역할을 한다는 것을 인지하자!)

이거는 appendix.rst에 대한 파일인데 부제목을 단위로 하여 파일 두개를 만들어서 하나의 space에 조립해놓을 것이다.

이렇게 분할해서 작업을 하는 것도 가능하다. 물론 이게 귀찮으면 분할하는 것도 가능하다.

단! 제목을 기준으로 제목과 동일한 폴더를 만들어서 그 안에 부제목에 해당하는 파일들을 채워넣어야 한다. 이게 규칙이다.

마치 예전에 JSP로 웹개발을 진행할때 서블릿을 조립하는 거랑 좀 비슷한거 같다ㅋㅋ

ERROR: Document may not end with a transition.

위 문제는 rst문법에 맞추지 않았기 때문에 발생하는 사소한? 이슈이다.

위 사진은 맨 마지막에 ‘——–‘라는 점선을 넣어준 건데, 중간줄에 저런 점선을 넣어주는 것에는 빌드상 문제가 없지만, 맨 마지막 contents에 저렇게 점선을 넣어주면 문법상 에러라고 ㅈㄹ을 한다…

그러니 맨 마지막줄에는 위와 같이 점선을 없애줄 필요가 있다.

WARNING: Bullet list ends without a blank line; unexpected unindent.

위 사진과 같이 “==================”위에 소제목(h3)을 적고 그 아에 bullet기호를 넣었더니,

이런 경고가 떴다. 경고를 없애려면 제목에 있는 bullet기호를 삭제해주자!

경고가 사라졌드아..

Pull Requests를 진행하자!

어느정도 문서화작성을 끝냈으니 이제 pull requests를 진행해야 한다.

현재 어떻게 되어 있냐면, sogongbang/rx003 리포지토리에 있는 내용을 내가 fork를 따왔고, 내 리포지토리에서 git clone을 따와서 작업을 진행하였다.

이후 내용 수정후 푸시와 커밋을 진행하여 나의 리포지토리에는 작업내용이 다 반영이 되어 있지만(이거를 v2라고 하자.), 아직 sogongbang/rx003의 리포지토리에는 반영이 되어 있지 않다ㅜ(이게 v1이라고 하자).

즉 v1과 v2로, 서로 버전이 맞지 않는 문제가 발생한다. 이를 해결하기 위해 다음 순서로 절차를 밟아야 한다.

1. Pull Requests 생성
2. 코드리뷰, Merge Pull Request
3. Merge 이후 Branch 삭제 및 동기화