Skip to content

Commit

Permalink
update top and update write link (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
usaturn authored Aug 18, 2024
1 parent 4b8f951 commit e69a42e
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 11 deletions.
4 changes: 1 addition & 3 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ slack_ のコミュニケーションや :doc:`勉強会 <event/index>` の開

最新のイベント情報については `シリーズ:Sphinx-users.jp <https://sphinxjp.connpass.com/>`_ で確認して下さい。

* 2022年03月22日(日) に `Sphinx をはじめよう 第3版 <https://www.oreilly.co.jp/books/9784873119830/>`_ がオライリー・ジャパンより発売されました。
* 2019年11月25日(月) に :doc:`SphinxCon JP 2019 <event/20191125_sphinxconjp/index>` を開催しました。
* 2019年01月12日(月) に :doc:`Sphinx + 翻訳 Hack-a-thon 開発合宿 <event/20190112_development_camp/index>` を開催しました。
* 2018年11月28日(水) に :doc:`SphinxCon JP 2018 <event/20181128_sphinxconjp/index>` を開催しました。
Expand All @@ -35,9 +36,6 @@ slack_ のコミュニケーションや :doc:`勉強会 <event/index>` の開
* 2016年07月29日(金) に `#ssmjp プレゼンツ「ささみのさは Sphinx のさ」 <http://ssm.pkan.org/?p=1175>`_ を開催しました。
* 2015年11月24日(火) に :doc:`SphinxCon JP 2015 <event/20151124_sphinxconjp/index>` を開催しました。
* 2015年10月12(月,祝) に `Sphinx+翻訳 Hack-a-thon 2015.10 in PyCon JP 2015 <https://sphinxjp.connpass.com/event/20535/>`__ を開催します。
* 2014年10月21日: Sphinxについてのインタビュー記事が掲載されました。
`OSSをHackしてキャリアが広がる~海外生まれのドキュメントツール『Sphinx』を開発・運営する日本人メンバーに聞く - エンジニアtype <https://engineer.typemag.jp/article/sphinx-hack>`__

* 2013年9月 に 世界初の Sphinx をテーマにした書籍 `Sphinxをはじめよう <https://www.oreilly.co.jp/books/9784873116488/>`_ がオライリー・ジャパンより発売されました。


Expand Down
1 change: 0 additions & 1 deletion source/reverse-dict/images/target.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ taget オプションを使います。これにより、画像をクリック
.. image:: ../img/python.png
:target: http://python.org
~~~~~~
適用例
Expand Down
48 changes: 41 additions & 7 deletions source/reverse-dict/writing/link.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
single: link
pair: link;inline
pair: link;image


リンクを貼りたい
================
Expand All @@ -18,14 +18,26 @@ URL直書き
詳しくは、 http://sphinx-users.jp を参照してください。
~~~~~~
適用例
~~~~~~

詳しくは、 http://sphinx-users.jp を参照してください。

reSTのインライン構文
--------------------

一番柔軟に利用できる方法がこれです。生のHTMLではなく、自分の好きなラベルを表示させることができます。

.. code-block:: rst
`Sphinxを知りたい方はこちらをクリック <http://sphinx-users.jp>`_
`Sphinxを知りたい方はこちらをクリック <http://sphinx-users.jp>`__
~~~~~~
適用例
~~~~~~

`Sphinxを知りたい方はこちらをクリック <http://sphinx-users.jp>`__

論文の参考文献のような記述法
----------------------------
Expand All @@ -38,22 +50,44 @@ reSTのインライン構文
.. _SphinxJP: http://sphinx-users.jp
~~~~~~
適用例
~~~~~~

Sphinxの詳しい情報源: SphinxJP_

.. _SphinxJP: http://sphinx-users.jp

画像をクリックした時のリンク
----------------------------

``:target:`` オプションを使ってURLを埋め込みます。URL以外にも、Sphinx内で使えるリファレンス名(上記の ``SphinxJP_``)も使えます。

.. code-block:: rst
.. image:: sphinx.png
.. image:: /reverse-dict/img/sphinx.png
:alt: Sphinx-Users.jpのロゴ
:target: http://sphinx-users.jp
Sphinxのドキュメント内の他のページへのリンク
--------------------------------------------
~~~~~~
適用例
~~~~~~

.. image:: /reverse-dict/img/sphinx.png
:alt: Sphinx-Users.jpのロゴ
:target: http://sphinx-users.jp

Sphinxのドキュメントへのリンクであれば、ドキュメントのファイル名(拡張子なし)を書くことでリンクを貼ることができます。
同じ Sphinx プロジェクト内のドキュメントへのリンク
--------------------------------------------------

同じ Sphinx プロジェクト内のドキュメントファイルパス(相対パス/絶対パス、拡張子なし)を ``:doc:`` ロールに書くことでリンクになります

.. code-block:: rst
くわしい使い方は :doc:`sample/index` に書かれています。
くわしい使い方は :doc:`../images/target.rst` に書かれています。
~~~~~~
適用例
~~~~~~

くわしい使い方は :doc:`../images/target` に書かれています。

0 comments on commit e69a42e

Please sign in to comment.