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

update link, master to release #399

Merged
merged 10 commits into from
Nov 10, 2022

Conversation

hexists
Copy link
Contributor

@hexists hexists commented Feb 20, 2022

  • mecab 설치시 최신 릴리즈 버전을 참조하도록 변경 #395
  • master branch 경로를 사용하는 파일들을 release branch 경로를 사용하도록 수정했습니다.
  • 해당 pr merge 후에는 release branch를 생성해야 합니다.
  • 해당 pr merge 후에는 새로운 버전을 릴리즈할 때, master branch -> release branch -> new version 순서로 진행해야 합니다.

버전별로 mecab 설치 파일을 참조할 수 있도록 수정했습니다.
자세한 내용은 아래 정리했습니다.
#399 (comment)

해당 pr 리뷰 부탁드립니다.

@combacsa
Copy link
Contributor

combacsa commented Mar 3, 2022

서로 다른 version 에 대한 문서에서 MeCab 설치 스크립트를 여전히 동일한 경로를 가리키는 점이 있어서, 어떤 방향으로 가면 좋을지 계속 고민이 되네요.

@hexists
Copy link
Contributor Author

hexists commented Mar 5, 2022

@combacsa
그렇겠네요. 좀 더 고민해보겠습니다. 의견 감사합니다.

@hexists
Copy link
Contributor Author

hexists commented Aug 6, 2022

@combacsa @minhoryang

(조금 오래 걸렸지만) 릴리즈 된 버전별로 mecab script 링크를 참조할 수 있도록 수정했습니다.

수정방법 입니다.

  • sphinx-substitution-extensions을 사용합니다.
  • docs/conf.py에 해당 extension을 사용한다고 명시하고, rst_prolog에 rst에서 사용할 수 있는 release 변수를 설정합니다.
  • docs/install.rst의 mecab script 경로에 docs/conf.py에서 지정한 release 변수를 사용하여 경로를 설정합니다.
  • sphinx-substitution-extensions 설치를 위해 RTD(readthedocs)의 admin의 고급설정, requirements file에서 requirements-dev.txt 설정이 필요합니다.

제한사항입니다.

  • 새로 릴리즈되는 버전부터 mecab script link가 수정됩니다.
    • 이전에 릴리즈된 버전은 master가 포함된 경로로 보입니다. 이는 RTD(readthedocs)에 이미 릴리즈 됐기 때문입니다.
  • master branch에서 생성되는 latest 문서도 버전이 들어간 mecab script 링크를 가지게 됩니다.
    • 검증된 릴리즈 버전의 스크립트 링크를 가르키고 있어 문제는 없어 보입니다.
  • github web page에서는 sphinx-substitution-extensions을 이용한 부분이 보이지 않습니다.

기타

  • rst_prolog와 parsed-literal 사용하면 extension 없이 가능하지만, indentation이 유지되지 않아 부득이하게 sphinx-substitution-extensions를 사용했습니다.
  • 테스트를 위해 fork한 konlpy를 이용해서 RTD 문서를 만들었습니다. link
    • konlpy에 merge 후 삭제하겠습니다.

@hexists
Copy link
Contributor Author

hexists commented Aug 6, 2022

@minhoryang
안녕하세요~ 혹시 doc 관련 pr을 올릴 때 po 파일 수정 내용도 다 commit 해야 할까요?
현재는 포함하지 않았는데요^^; 확인 부탁드립니다. 감사합니다.

참고, https://github.com/konlpy/konlpy/blob/master/CONTRIBUTING.rst#modify-and-push-docs

@combacsa
Copy link
Contributor

제가 readthedocs 쪽은 권한이 없어서, @hexists 님께서 말씀하신 권한이 있는 @minhoryang 님께서 봐 주시면 좋을 거 같습니다!

@combacsa
Copy link
Contributor

combacsa commented Nov 8, 2022

@hexists 님, @e9t 님과 연락이 닿아서, 관련된 permission 이 부여되었을 거 같습니다. 한번 확인해주시겠어요? 이메일로 초대장이 왔을 겁니다.

@hexists
Copy link
Contributor Author

hexists commented Nov 8, 2022

@combacsa
오! 감사합니다. 이메일로 권한 받았습니다.
도와주셔서 감사합니다.

확인후에 반영하겠습니다. (제가 리뷰 후 반영해도 되겠죠?^^)

@e9t
권한 부여 감사합니다.

cc. @minhoryang

@combacsa
Copy link
Contributor

네 그리고 저희 한번 11월중에 0.6.1 릴리즈 하면서 doc 이 의도대로 작동하는지 확인하고, Python 2 지원 거기까지로 선언하고, 0.7.0 부터는 Python 3 으로 넘어가면 어떨까 생각됩니다. 일단 이 PR(풀리퀘)는 머지 해버리시지요.

@hexists
Copy link
Contributor Author

hexists commented Nov 10, 2022

@combacsa
좋습니다.
안그래도 python2 지원을 종료해야 겠다는 생각이 있었어요.
그럼 일단 작업 내용 merge 해놓겠습니다.
감사합니다.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants